From 42f1a4d574975cf93c9e2e1f1a504f768b47fd04 Mon Sep 17 00:00:00 2001 From: Daniel Cadenas Date: Thu, 22 Feb 2024 13:00:34 -0300 Subject: [PATCH] Update README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 67bb404..7a18389 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,10 @@ pnpm test ## Usage +We expect that clients will hit specific endpoints for creation and updates (POST) and deletion (DELETE). + +Although the NIP accepts dots and underscores in names, we only allow a smaller subset without them so that we are more friendly to http redirection. + ### POST Endpoint To securely authenticate POST requests to the `nip05api` endpoint, utilize the [NIP-98](https://github.com/nostr-protocol/nips/blob/master/98.md) HTTP authentication method. This involves creating a signed Nostr event as per NIP 98 specifications, encoding it in base64, and including it in the `Authorization` header. @@ -90,6 +94,10 @@ The GET endpoint implements NIP-05 functionality. No authentication is required curl -H 'Host: nos.social' http://127.0.0.1:3000/.well-known/nostr.json?name=alice ``` +### External Setup + +We configure rate limits and redirects to njump through our [Traefik infra config](https://github.com/planetary-social/ansible-scripts/tree/main/roles/nos_social) + ## Contributing Contributions are welcome! Fork the project, submit pull requests, or report issues.