diff --git a/README.md b/README.md index 467e174..1744413 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ A cool little web app that shows your Discord profile, current activity, and more. Built with Bun. +# Preview +https://creations.works + --- ## Requirements @@ -96,6 +99,19 @@ Make sure the `.env` file is configured correctly before starting the container. --- +## Routes + +These are the main public routes exposed by the server: + +| Route | Description | +|---------------|-----------------------------------------------------------------------------| +| `/` | Loads the profile page for the default Discord user defined in `.env` (`LANYARD_USER_ID`) | +| `/[id]` | Loads the profile page for a specific Discord user ID passed in the URL | + +> Example: `https://creations.works/209830981060788225` shows the profile of that specific user. + +--- + ## License [BSD 3](LICENSE)