Merge pull request #64 from csfloat/feature/readme

Update Readme

Author: zedimytch

README.md

@@ -1 +1,50 @@
-# Reverse.Watch
+# [reverse.watch](https://reverse.watch)
+
+Community-driven open trade reversal tracking database for Steam. Participating entities can report trade reverals to the open database.
+
+## Interested in Participating?
+
+If you're looking to participate by contributing reversal reports (i.e. marketplace, trading tool, community site, etc...), reach out at **join@reverse.watch**.
+
+## Running Locally
+
+1. Ensure Go 1.24+ and PostgreSQL are installed.
+2. Copy the config template and fill in your local database credentials:
+   ```bash
+   cp config.example.json config.json
+   ```
+3. Run the service:
+   ```bash
+   go run main.go
+   ```
+
+The server starts on port `80` by default (configurable via `HTTP_PORT`).
+
+## Configuration
+
+Configuration is loaded from environment variables or a `config.json` file.
+
+## Authentication
+
+All entity endpoints require a Bearer token in the `Authorization` header:
+
+```
+Authorization: Bearer reversewatch_live_xxxxxxxx...
+```
+
+API keys are scoped to an entity and carry a permission bitfield. Keys are prefixed with `reversewatch_live_` (production) or `reversewatch_test_` (development).
+
+### Permissions
+
+| Permission | Description |
+|---|---|
+| `admin` | Full administrative access (Service operator only) |
+| `manage` | Manage API keys for own entity |
+| `write` | Create reversal reports |
+| `delete` | Expunge reversal reports for own entity |
+| `read` | Read access |
+| `export` | List and export reversal data |
+
+## Rate Limiting
+
+Rate limits are enforced in-memory per process. Throttled responses return `429 Too Many Requests` with `X-RateLimit-*` and `Retry-After` headers.

config.example.json

@@ -0,0 +1,15 @@
+{
+    "Database": {
+        "Host": "localhost",
+        "Port": "5432",
+        "User": "postgres",
+        "Password": "postgres",
+        "PrivateDBName": "private",
+        "PublicDBName": "public"
+    },
+    "HTTP": {
+        "Port": "3434",
+        "AllowedOrigins": ["allowed-origin-1", "allowed-origin-2"]
+    },
+    "Environment": "development"
+}