Skip to content

Commit

Permalink
small improvements to docs (#38)
Browse files Browse the repository at this point in the history
  • Loading branch information
amorey authored Apr 22, 2024
1 parent cadc84d commit e6c2a29
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Edge-CSRF is a CSRF protection library for JavaScript that runs on the [edge runtime](https://edge-runtime.vercel.app/).

The Edge-CSRF library helps you to implement the [signed double submit cookie pattern](https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html#signed-double-submit-cookie-recommended) except it only uses edge runtime dependencies so it can be used in both node environments and in edge functions (e.g. [Vercel Edge Functions](https://vercel.com/docs/functions/runtimes/edge-runtime), [Cloudflare Page Functions](https://developers.cloudflare.com/pages/functions/)). The recommended way to use this library is via its drop-in integrations for [Next.js](src/nextjs) and [SvelteKit](src/sveltekit) though it also has a lower-level API for more custom implementations.
The Edge-CSRF library helps you to implement the [signed double submit cookie pattern](https://cheatsheetseries.owasp.org/cheatsheets/Cross-Site_Request_Forgery_Prevention_Cheat_Sheet.html#signed-double-submit-cookie-recommended) except it only uses edge runtime dependencies so it can be used in both node environments and in edge functions (e.g. [Vercel Edge Functions](https://vercel.com/docs/functions/runtimes/edge-runtime), [Cloudflare Page Functions](https://developers.cloudflare.com/pages/functions/)). The recommended way to use this library is via its drop-in integrations for Next.js and SvelteKit though it also has a lower-level API for more custom implementations.

We hope you enjoy using this software. Contributions and suggestions are welcome!

Expand All @@ -25,7 +25,7 @@ We hope you enjoy using this software. Contributions and suggestions are welcome

## Quickstart (Next.js)

First, install the Edge-CSRF Next.js integration library:
First, install Edge-CSRF's Next.js integration library:

```console
npm install @edge-csrf/nextjs
Expand Down Expand Up @@ -84,7 +84,7 @@ export async function POST() {

## Quickstart (SvelteKit)

First, install the Edge-CSRF SvelteKit integration library:
First, install Edge-CSRF's SvelteKit integration library:

```console
npm install @edge-csrf/sveltekit
Expand Down
2 changes: 1 addition & 1 deletion packages/nextjs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Next.js

This is the documentation for the Edge-CSRF's Next.js integration. The integration works with Next.js 13 and Next.js 14.
This is the documentation for Edge-CSRF's Next.js integration. The integration works with Next.js 13 and Next.js 14.

## Quickstart

Expand Down

0 comments on commit e6c2a29

Please sign in to comment.