Added more info about public instance
All checks were successful
Tests / test (3.10) (push) Successful in 11s
Tests / test (3.11) (push) Successful in 9s
Tests / test (3.9) (push) Successful in 9s
Tests / test (3.10) (pull_request) Successful in 9s
Tests / test (3.11) (pull_request) Successful in 8s
Tests / test (3.9) (pull_request) Successful in 9s

This commit is contained in:
2024-05-26 14:27:12 +02:00
parent 42d6eb312b
commit d4e8522687
3 changed files with 30 additions and 4 deletions

View File

@@ -1,3 +1,29 @@
# Public instance
This section is under construction.
There is a publicly available hosted version of the API and all clients.
## When to use public instance
You should use public instance if:
* You need garbage reminders for [Gemeinde Schmitten](https://www.schmitten.de){:target="_blank"}
* You need a stable bot and API versions with good uptime
* You want to contribute [locations](locations.md) and/or [entries](entries.md)
* You need community and developer [support](report.md)
You should **NOT** use public instance if:
* You want to modify the source code
* You have non-standard garbage types
* You want to add non-standardized locations
## Start using it
### API
* Endpoint: <https://api.garbagebot.eu>{:target="_blank"}
* Docs: [Swagger](https://api.garbagebot.eu/docs){:target="_blank"} / [Redoc](https://api.garbagebot.eu/redoc){:target="_blank"}
### Telegram Bot
* Link: <https://t.me/GarbageReminder_Bot>{:target="_blank"}