diff --git a/README.md b/README.md index b098fe1..c9987a8 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,9 @@ By default publapi listens on 127.0.0.1:3000. You can change the port with the e Additionally, you need to set the variable PUBLAPI_SHOUTRRRURL in order for notifications to work. Url Format can be found at https://containrrr.dev/shoutrrr/v0.5/services/matrix/ ## Usage -Currently, PublAPI has only two routes, /online and /signup. +Currently, PublAPI has only two routes, /users and /signup. -| ROUTE | TYPE | EXTRA ARGS | DESCRIPTION | -|---------|------|-----------------|------------------------------------| -| /online | GET | N/A | Returns the number of online users | +| ROUTE | TYPE | EXTRA ARGS | DESCRIPTION | +|---------|------|----------------------|---------------------------------| +| /users | GET | N/A | Return information about users. | | /signup | POST | username, email, ssh | Creates a register script and notifies admins that a new registration request was sent.| diff --git a/main.go b/main.go index b863bba..63cb8bd 100644 --- a/main.go +++ b/main.go @@ -97,10 +97,10 @@ func main() { }) }) - app.Get("/online", func(c *fiber.Ctx) error { + app.Get("/users", func(c *fiber.Ctx) error { if runtime.GOOS == "windows" { return c.JSON(fiber.Map{ - "message": "/online is not supported on Windows", + "message": "/users is not supported on Windows", "status": c.Response().StatusCode(), }) }