Skip to content

Commit

Permalink
Small readme tweak
Browse files Browse the repository at this point in the history
  • Loading branch information
Murderlon committed Sep 20, 2023
1 parent 5f36eea commit 9061d30
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,15 @@ integrable in any Node.js server (even a front-end framework like Next.js).
camomile works together with [`rehype-github-image`][],
which does the following at build time:

1. The original URL in the content is parsed.
1. Finds all insecure HTTP image URLs.
2. An [HMAC][] signature of the URL is generated.
3. The URL and HMAC are encoded.
4. The encoded URL and HMAC are placed into the expected format,
creating the signed URL.
5. The signed URL replaces the original image URL.

After your web app serves the content to the user, camomile takes over:
After your web app serves the content to the user,
camomile takes over where needed:

1. The client requests the signed URL from camomile.
2. camomile validates the [HMAC][], decodes the URL,
Expand Down

0 comments on commit 9061d30

Please sign in to comment.