diff --git a/README.md b/README.md index 3fee809..dd4f63a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,14 @@ -Deploy this repo to Netlify, then go to https://authlify-dev.netlify.app/ to enable the addon +1. Deploy this repo to Netlify using +[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/sgrove/secrets-test) + +2. Go to https://authlify-dev.netlify.app/ to enable the addon + +3. After enabling Authlify for a site, be sure to force a new deploy with `clear cache and deploy site` (this will be done automatically with an update on Sunday) After it's deployed, you can hit three endpoints: -1. "/.netlify/functions/secret" - see all enabled auths + secrets -1. "/.netlify/functions/conditionalSecrets?skipSecrets=true" - see and endpoint that can optionally retrieve secrets, useful to see the overhead of the current implementation +1. "/.netlify/functions/secrets" - see all enabled auths + secrets (sanitized so they're not exposed) +1. "/.netlify/functions/conditionalSecrets?skipSecrets=true" - an endpoint that can optionally retrieve secrets, useful to see the overhead of the current implementation 1. "/.netlify/functions/addIssueComment?comment=Hello there!" - an endpoint that requires GitHub to be authenticated with sufficient scopes (default should be fine). Will leave a comment on https://github.com/sgrove/blog/issues/66 -Be sure to destroy the app after you finish testing so there are no leaked secrets. \ No newline at end of file +Be sure to destroy the app after you finish testing so there are no leaked secrets.