araclx / mello

Privacy-focused Social Metwork which connects right people's in efficient way
https://m3llo.co
GNU General Public License v3.0
4 stars 2 forks source link

docs: add basic guide (MEL-8) #25

Closed keinsell closed 2 years ago

linear[bot] commented 2 years ago
MEL-9 Add README.md

Our repository is publicly exposed in this case we should make some juicy introduction to our project and actually how to use it (even in retarded way for now). Final `README` should contain following elements: * [ ] Introduction * [ ] Usage * [ ] Documentation * [ ] Contributing * [ ] License * [ ] Credits

MEL-8 API Documentation Solution

> We need to find solution for API Endpoint documentation for our whole API and sockets. We don't have really much options, there we have OpenAPI 3.0 and Postman.