Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
TimMikeladze committed Aug 2, 2024
1 parent dac3523 commit 454c1bc
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,10 @@ Protect your Next.js app with a password. A drop-in solution to keep your deploy
## ✨ Features

- [x] Integrates with Next.js App Router.
- [x] Supports Next.js Middleware.
- [x] Supports Next.js Middleware, Edge runtime, RSC and SSR out of the box.
- [x] Protect just a specific page or the entire app.
- [x] Edge runtime, RSC and SSR out of the box.
- [x] Use one or more passwords.
- [x] Customize the form.
- [x] Customizable form.

> Check-out a [NextJS example](./examples/nextjs-example/) or view the [Demo](https://next-protect.vercel.app/).
Expand All @@ -27,7 +26,7 @@ pnpm add next-flag
## 🚀 Getting started

First, modify your `.env` file to include a `NEXT_PROTECT_PASSWORD="password-goes-here"`.
First, modify your `.env` file to include a new environment variable: `NEXT_PROTECT_PASSWORD="password-goes-here"`.

Next we need to instantiate the `NextProtect` class. This instance provides the core functionality of the package. Create a new file `src/app/api/next-protect/index.ts` and export the `NextProtect` class.

Expand Down Expand Up @@ -107,7 +106,7 @@ If you are using React Client Components, simply render a `NextProtect` componen

```tsx
/* src/app/page.tsx */
import { useEffect } from 'react';
import { NextProtect } from 'next-protect/react';

const Page = () => {
return (
Expand Down

0 comments on commit 454c1bc

Please sign in to comment.