add license and readme
Signed-off-by: Peter Siegmund <developer@mars3142.org>
This commit is contained in:
19
README.md
Normal file
19
README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# Timezone Service for Firmware-HQ
|
||||
|
||||
## Endpoints
|
||||
|
||||
`curl https://timezone.firmware-hq.dev/v1/timezone`
|
||||
|
||||
Will return the timezone information for the requesting client. Uses the external IP of the client
|
||||
|
||||
`curl https://timezone.firmware-hq.dev/v1/timezone/Europe`
|
||||
|
||||
Will return all locations within the area.
|
||||
|
||||
`curl https://timezone.firmware-hq.dev/v1/timezone/Europe/Berlin`
|
||||
|
||||
Will return the timezone information for a specific area/location combination.
|
||||
|
||||
## Responses
|
||||
|
||||
All endpoint will return a 200 or 404 (in case of an error).
|
Reference in New Issue
Block a user