feat: add readme

This commit is contained in:
Jet Pham 2026-03-05 13:22:19 -08:00
parent 8daedbd5b6
commit 658381307d
No known key found for this signature in database

15
README.md Normal file
View file

@ -0,0 +1,15 @@
# mymx
Webhook receiver for [MyMX](https://mymx.email) email events. Verifies signatures and stores emails in PostgreSQL.
## Usage
```bash
createdb mymx
export DATABASE_URL="postgres:///mymx"
export MYMX_WEBHOOK_SECRET="your-webhook-secret"
sqlx migrate run --source mymx-server/migrations
cargo run -p mymx-server
```
Point your MyMX endpoint to `https://your-domain/webhook`.