chore: add readme

Author: steveiliop56

dashboard/.gitignore

@@ -0,0 +1,2 @@
+# build out
+dashboard

dashboard/README.md

@@ -0,0 +1,34 @@
+# Dashboard
+
+A simple server that periodically fetches data from the analytics server API and displays them in a simple dashboard.
+
+## Usage
+
+Build the binary with:
+
+```sh
+go build .
+```
+
+And run with:
+
+```
+./dashboard
+```
+
+Then visit <http://localhost:8080> to see the analytics.
+
+> [!NOTE]
+> A docker image is also available, check out the example [docker compose](../docker-compose.yml) file.
+
+## Configuration
+
+You can configure the server using environment variables, the following options are supported:
+
+| Name               | Type   | Description                                      | Default                    |
+| ------------------ | ------ | ------------------------------------------------ | -------------------------- |
+| `PORT`             | number | The port to run the server on.                   | `8080`                     |
+| `ADDRESS`          | string | The address to bind the server to.               | `0.0.0.0`                  |
+| `API_SERVER`       | string | The analytics API server URL to fetch data from. | `https://api.tinyauth.app` |
+| `PAGE_SIZE`        | number | Number of instances to display per page.         | `10`                       |
+| `REFRESH_INTERVAL` | number | How often to refresh data from API (in minutes). | `30`                       |