Skip to content

Commit 6029587

Browse files
committed
docs: update README getting started with updated env configuration
1 parent c70b2e1 commit 6029587

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ It’s designed for indie developers or small teams who need a simple way to man
5252
- Public endpoint to report and accumulate playtime, allowing game clients to increment hours played.
5353
- Easy to integrate with Unity or any custom launcher/client.
5454
- Organized structure using use cases, services, DTOs, validators, and minimal APIs.
55+
- Send Discord notifications via `DISCORD_WEBHOOK_URL` whenever a tester successfully validates access, allowing real-time monitoring of usage.
5556

5657
## 🧰Tech Stack
5758
- [.NET 8 (Web API)](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
@@ -73,8 +74,21 @@ cd src
7374
```
7475
- Create a `.env` file:
7576
```.env
77+
# ---------------------------------------------------------
78+
# Admin authentication key for protected endpoints
79+
# ---------------------------------------------------------
7680
API_KEY=your-admin-key
81+
82+
# ---------------------------------------------------------
83+
# SQLite database file used to store testers and access logs
84+
# ---------------------------------------------------------
7785
SQLITE_DATA_SOURCE=playtesters.db
86+
87+
# ---------------------------------------------------------
88+
# Discord webhook URL for sending notifications
89+
# (set this only if you want Discord alerts)
90+
# ---------------------------------------------------------
91+
DISCORD_WEBHOOK_URL=https://discord.com/api/webhooks/xxxxx/xxxxx
7892
```
7993
- Run the API:
8094
```bash

0 commit comments

Comments
 (0)