From 05468d55b4959b8b77cf12152266507773f5dd72 Mon Sep 17 00:00:00 2001 From: Alexandre Teles Date: Sun, 28 Aug 2022 20:37:41 -0300 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d5ffd1..cc99598 100644 --- a/README.md +++ b/README.md @@ -1 +1,25 @@ -I'll update this, leave me alone. \ No newline at end of file +![License: AGPLv3](https://img.shields.io/github/license/alexandreteles/revanced-releases-api) +![GitHub last commit](https://img.shields.io/github/last-commit/alexandreteles/revanced-releases-api) +![GitHub Workflow Status](https://img.shields.io/github/workflow/status/alexandreteles/revanced-releases-api/Build%20and%20push%20Docker%20image) + +# ReVanced Releases API + +This is a simple API that returns the latest ReVanced releases. + +## Usage + +The API is available at [to be decided]. + +For development purposes, you can run the API locally by cloning this repository and running `docker-compose up` or `docker-compose up --build` if you want to rebuild the image. Optionally you can run the application without Docker by running `pip -U install -r ./requirements.txt` and `python ./main.py`. + +## Contributing + +If you want to contribute to this project, feel free to open a pull request or an issue. We don't do much here, so it's pretty easy to contribute. + +## License + +This project is licensed under the AGPLv3 License - see the [LICENSE](LICENSE) file for details. + +## Acknowledgments + +* [ReVanced Team](https://github.com/revanced/) for making such a great project \ No newline at end of file