Merge remote-tracking branch 'origin/master'

This commit is contained in:
Charles Le Maux 2024-07-01 14:42:40 +01:00
commit 07743946db

View File

@ -3,7 +3,7 @@
[![PyPI](https://img.shields.io/pypi/v/PyGithub.svg)](https://pypi.python.org/pypi/PyGithub) [![PyPI](https://img.shields.io/pypi/v/PyGithub.svg)](https://pypi.python.org/pypi/PyGithub)
![CI](https://github.com/PyGithub/PyGithub/workflows/CI/badge.svg) ![CI](https://github.com/PyGithub/PyGithub/workflows/CI/badge.svg)
![Static Badge](https://img.shields.io/badge/servii-V1.0.0-pink?style=flat) ![Static Badge](https://img.shields.io/badge/servii-V1.0.0-pink?style=flat)
[![Static Badge](https://img.shields.io/badge/%F0%9F%93%9A-%202.7.1%20-36A4A4)](https://www.servii.fr/api-docs/)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
Servii is a cutting-edge project designed to streamline the management of Minecraft servers and facilitate seamless integration with frontend applications. Servii is a cutting-edge project designed to streamline the management of Minecraft servers and facilitate seamless integration with frontend applications.
@ -44,9 +44,11 @@ gunicorn -w 4 -b 0.0.0.0:3000 app:app
``` ```
## Documentation ## Documentation
The [documentation] isn't public yet. The API's {[Documentation]} is now complete !!
This project is self documented and ready to understand.
Start reading at app.py, and even if the rest isn't that self explainatory, read the "generic_executor.py' file to understand how everything globally works.
[documentation]: https://doc.servii.fr/back-end [Documentation]: https://www.servii.fr/api-docs/
## Development ## Development
@ -61,4 +63,4 @@ We're actively seeking maintainers that will triage issues and pull requests and
If you work on a project that leverages Servii and have a vested interest in keeping the code alive and well, send an email to [charles@le-maux.dev], thank you for reading. If you work on a project that leverages Servii and have a vested interest in keeping the code alive and well, send an email to [charles@le-maux.dev], thank you for reading.
[charles@le-maux.dev]: charles@le-maux.dev [charles@le-maux.dev]: charles@le-maux.dev