Update README.md

This commit is contained in:
Alexandre Teles 2022-08-28 20:37:41 -03:00
parent 2aed46cfb0
commit 05468d55b4

View File

@ -1 +1,25 @@
I'll update this, leave me alone.
![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