Skip to content

Commit da39bbd

Browse files
committed
doc: add nuxt 4 support info
1 parent cf9af1f commit da39bbd

6 files changed

Lines changed: 14 additions & 8 deletions

File tree

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Nuxt Users
22

3-
A user authentication module for Nuxt 3 with database support for SQLite and MySQL.
3+
A user authentication module for Nuxt 3 and Nuxt 4 with database support for SQLite, MySQL, and PostgreSQL.
44

55
## Features
66

77
- 🔐 User authentication with bcrypt password hashing
8-
- 🗄️ Database support (SQLite, MySQL)
8+
- 🗄️ Database support (SQLite, MySQL, PostgreSQL)
99
- 🛠️ CLI commands for database management
1010
- 🔑 Password Reset Functionality
1111
- 📦 Zero-config setup with sensible defaults
1212
- 🔧 TypeScript support
13+
- 🚀 Nuxt 3 & 4 compatibility
1314

1415
## Quick Start
1516

docs/get-started.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Nuxt Users
22

3-
A user authentication module for Nuxt 3 with database support for SQLite, MySQL, and PostgreSQL.
3+
A user authentication module for Nuxt 3 and Nuxt 4 with database support for SQLite, MySQL, and PostgreSQL.
44

55
## Features
66

@@ -41,6 +41,7 @@ npx nuxt-users create-user user@example.com "John Doe" password123
4141

4242
## What's Included
4343

44+
- **Nuxt 3 & 4 Support**: Fully compatible with both Nuxt 3 and Nuxt 4
4445
- **Authentication System**: Secure login with token-based authentication
4546
- **Database Support**: SQLite, MySQL, and PostgreSQL with automatic migrations
4647
- **Password Reset**: Complete email-based password reset flow

docs/guide/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Basic Configuration
44

5-
The module can be configured in your `nuxt.config.ts`:
5+
The module can be configured in your `nuxt.config.ts` (compatible with both Nuxt 3 and Nuxt 4):
66

77
```ts
88
export default defineNuxtConfig({

docs/guide/installation.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Installation
22

3+
## Nuxt Version Support
4+
5+
This module is compatible with both **Nuxt 3** and **Nuxt 4**. The installation and configuration process is the same for both versions.
6+
37
## Install the Module
48

59
```bash
@@ -28,7 +32,7 @@ npm install @formkit/nuxt
2832

2933
## Add to Nuxt Config
3034

31-
Add the module to your `nuxt.config.ts`:
35+
Add the module to your `nuxt.config.ts` (works for both Nuxt 3 and Nuxt 4):
3236

3337
```ts
3438
export default defineNuxtConfig({

docs/guide/quick-start.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Quick Start
22

3-
Get up and running with Nuxt Users in minutes.
3+
Get up and running with Nuxt Users in minutes. This guide works for both Nuxt 3 and Nuxt 4.
44

55
## 1. Install the Module
66

docs/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ layout: home
44

55
hero:
66
name: "Nuxt Users Module"
7-
text: "A user authentication module for Nuxt 3 with database support for SQLite, MySQL, and PostgreSQL"
8-
tagline: That provides a full stack user authentication system for Nuxt 3 projects.
7+
text: "A user authentication module for Nuxt 3 & 4 with database support for SQLite, MySQL, and PostgreSQL"
8+
tagline: That provides a full stack user authentication system for Nuxt 3 and Nuxt 4 projects.
99
actions:
1010
- theme: brand
1111
text: Get Started

0 commit comments

Comments
 (0)