Improve basic documentation

jolpica / jolpica-f1

Apache License 2.0

41 stars 1 forks source link

Improve basic documentation #34

Open chrisfree opened 4 months ago

chrisfree commented 4 months ago

Needs before opening beta testing:

Rate limiting information
Known differences between Jolpica and Ergast
- Example: our API doesn't support XML responses like Ergast does
Replicating Ergast documentation in Markdown within this repository
Details on how/when data is updated from source

theOehrly commented 2 months ago

Did we have a favoured solution for documentation already? I think we briefly discussed using Github Wikis at some point?

chrisfree commented 2 months ago

We decided on today's status call to keep any and all documentation for Jolpica within this repository and to format all of it using Markdown. This has the added benefit of being simple/easy to use as the source of a future Jolpica documentation website.