Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add supported runtimes section and Cloudflare import note #286

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add supported runtimes section and Cloudflare import note #286

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,13 @@ Heavily inspired by [Passport.js](https://passportjs.org), but completely rewrot

As with Passport.js, it uses the strategy pattern to support the different authentication flows. Each strategy is published individually as a separate npm package.

## Supported runtimes

| Runtime | Has Support |
| ---------- | ----------- |
| Node.js | ✅ |
| Cloudflare | ✅ |

## Installation

To use it, install it from npm (or yarn):
Expand Down Expand Up @@ -57,6 +64,12 @@ export let sessionStorage = createCookieSessionStorage({
export let { getSession, commitSession, destroySession } = sessionStorage;
```

> If you are deploying to Cloudflare, you need to import from `@remix-run/cloudflare`:
> ```
> import { createCookieSessionStorage } from "@remix-run/cloudflare";
> ```


Now, create a file for the Remix Auth configuration. Here import the `Authenticator` class and your `sessionStorage` object.

```ts
Expand Down