From 140c04045e4d51d80766c04c32d16ad95af076e8 Mon Sep 17 00:00:00 2001 From: Rudis Muiznieks Date: Sun, 29 Aug 2021 18:56:43 -0500 Subject: [PATCH] added note about experimental jsonb feature to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 345d27b..b77cd8b 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,10 @@ The reference dotplan implementation exposes this endpoint to update a plan usin - `auth` - the authentication token - omitting `plan` from the payload will delete the existing plan +### Experimental + +If experimental features are enabled in this reference implementation, `GET /js/{email}` with an optional `callback` parameter will return a [JSONP](https://en.wikipedia.org/wiki/JSONP) script that calls your function (`handle_dotplan` by default), passing the plan in json format. You can also optionally specify a `pubkey` parameter (if verification fails it will return an `{"error":"..."}` object). + ## Discovery via Domain SRV To facilitate service discovery by Dotplan clients and relays, add a [SRV record](https://en.wikipedia.org/wiki/SRV_record) to your email domain with the name `_dotplan._tcp`. For example, to use `dotplan.online` as the service provider for email addresses at `example.com`, the record would look like this: