charleslemaux/servii-backend
1
0
Fork 0
mirror of https://github.com/hubHarmony/servii-backend.git synced 2024-11-17 21:40:31 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[~] Clarified documentation context in 'readme.md"

Browse Source
This commit is contained in:
charleslemaux 2024-06-30 05:51:00 +01:00 committed by GitHub
parent 6b9df8e668
commit 892a884c4f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
readme.md
View File

@ -44,9 +44,11 @@ gunicorn -w 4 -b 0.0.0.0:3000 app:app
``` ```
## Documentation ## Documentation
The [documentation] isn't public yet. [Documentation] is in building state.
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://api.servii.fr/doc
## 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