feat: add readme
This commit is contained in:
parent
8daedbd5b6
commit
658381307d
1 changed files with 15 additions and 0 deletions
15
README.md
Normal file
15
README.md
Normal 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`.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue