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.

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

docs: use new nuxi module add command in installation #74

Merged
merged 2 commits into from
Apr 3, 2024
Merged
Changes from all commits
Commits
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
24 changes: 3 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,30 +23,13 @@ This module only works with SSR (server-side rendering) enabled as it uses serve

## Quick Setup

1. Add `nuxt-auth-utils` dependency to your project
1. Add `nuxt-auth-utils` in your Nuxt project

```bash
# Using pnpm
pnpm add -D nuxt-auth-utils

# Using yarn
yarn add --dev nuxt-auth-utils

# Using npm
npm install --save-dev nuxt-auth-utils
```

2. Add `nuxt-auth-utils` to the `modules` section of `nuxt.config.ts`

```js
export default defineNuxtConfig({
modules: [
'nuxt-auth-utils'
]
})
npx nuxi@latest module add auth-utils
```

3. Add a `NUXT_SESSION_PASSWORD` env variable with at least 32 characters in the `.env`.
2. Add a `NUXT_SESSION_PASSWORD` env variable with at least 32 characters in the `.env`.

```bash
# .env
Expand All @@ -57,7 +40,6 @@ Nuxt Auth Utils generates one for you when running Nuxt in development the first

3. That's it! You can now add authentication to your Nuxt app ✨


## Vue Composables

Nuxt Auth Utils automatically adds some plugins to fetch the current user session to let you access it from your Vue components.
Expand Down
Loading