diff --git a/README.md b/README.md new file mode 100644 index 0000000..c1b4995 --- /dev/null +++ b/README.md @@ -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`.