docs added closes #12

Author: rrd108

README.md

@@ -0,0 +1,82 @@
+import { defineConfig } from 'vitepress'
+
+export default defineConfig({
+  title: 'Nuxt Users',
+  description: 'A user authentication module for Nuxt 3 with database support for SQLite and MySQL',
+  themeConfig: {
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Guide', link: '/guide/' },
+      { text: 'API', link: '/api/' },
+      { text: 'Components', link: '/components/' },
+      { text: 'Database', link: '/database/' },
+      { text: 'Contributing', link: '/contributing/' }
+    ],
+    sidebar: {
+      '/guide/': [
+        {
+          text: 'Getting Started',
+          items: [
+            { text: 'Installation', link: '/guide/installation' },
+            { text: 'Quick Start', link: '/guide/quick-start' },
+            { text: 'Configuration', link: '/guide/configuration' }
+          ]
+        },
+        {
+          text: 'Features',
+          items: [
+            { text: 'Authentication', link: '/guide/authentication' },
+            { text: 'Password Reset', link: '/guide/password-reset' },
+            { text: 'Database Setup', link: '/guide/database-setup' }
+          ]
+        }
+      ],
+      '/api/': [
+        {
+          text: 'API Reference',
+          items: [
+            { text: 'Login', link: '/api/login' },
+            { text: 'Password Reset', link: '/api/password-reset' }
+          ]
+        }
+      ],
+      '/components/': [
+        {
+          text: 'Components',
+          items: [
+            { text: 'LoginForm', link: '/components/login-form' },
+            { text: 'ForgotPasswordForm', link: '/components/forgot-password-form' },
+            { text: 'ResetPasswordForm', link: '/components/reset-password-form' }
+          ]
+        }
+      ],
+      '/database/': [
+        {
+          text: 'Database',
+          items: [
+            { text: 'Schema', link: '/database/schema' },
+            { text: 'Migrations', link: '/database/migrations' },
+            { text: 'CLI Commands', link: '/database/cli-commands' }
+          ]
+        }
+      ],
+      '/contributing/': [
+        {
+          text: 'Contributing',
+          items: [
+            { text: 'Development Setup', link: '/contributing/development-setup' },
+            { text: 'Running Tests', link: '/contributing/running-tests' },
+            { text: 'Guidelines', link: '/contributing/guidelines' }
+          ]
+        }
+      ]
+    },
+    socialLinks: [
+      { icon: 'github', link: 'https://github.com/your-org/nuxt-users' }
+    ],
+    footer: {
+      message: 'Released under the MIT License.',
+      copyright: 'Copyright © 2024-present'
+    }
+  }
+})

docs/.vitepress/config.ts

@@ -0,0 +1,126 @@
+# API Reference
+
+The Nuxt Users module provides several API endpoints for authentication and password reset functionality.
+
+## Authentication Endpoints
+
+### Login
+
+**Endpoint:** `POST /api/login`
+
+Authenticate a user with email and password.
+
+**Request Body:**
+```json
+{
+  "email": "user@example.com",
+  "password": "password123"
+}
+```
+
+**Response:**
+```json
+{
+  "user": {
+    "id": 1,
+    "email": "user@example.com",
+    "name": "John Doe",
+    "created_at": "2024-01-01T00:00:00.000Z",
+    "updated_at": "2024-01-01T00:00:00.000Z"
+  }
+}
+```
+
+**Error Responses:**
+- `400 Bad Request`: Missing email or password
+- `401 Unauthorized`: Invalid credentials
+
+## Password Reset Endpoints
+
+### Forgot Password
+
+**Endpoint:** `POST /api/forgot-password`
+
+Send a password reset link to the user's email.
+
+**Request Body:**
+```json
+{
+  "email": "user@example.com"
+}
+```
+
+**Response:**
+```json
+{
+  "message": "Password reset link sent to your email"
+}
+```
+
+**Notes:**
+- Always returns success message (prevents email enumeration)
+- Sends email only if user exists
+- Token expires after 1 hour
+
+### Reset Password
+
+**Endpoint:** `POST /api/reset-password`
+
+Reset user password using a valid token.
+
+**Request Body:**
+```json
+{
+  "token": "reset-token-from-email",
+  "email": "user@example.com",
+  "password": "new-password",
+  "password_confirmation": "new-password"
+}
+```
+
+**Response:**
+```json
+{
+  "message": "Password reset successfully"
+}
+```
+
+**Error Responses:**
+- `400 Bad Request`: Missing required fields
+- `401 Unauthorized`: Invalid or expired token
+- `422 Unprocessable Entity`: Password confirmation mismatch
+
+## Error Handling
+
+All endpoints return consistent error responses:
+
+```json
+{
+  "statusCode": 400,
+  "statusMessage": "Error description"
+}
+```
+
+## Authentication Headers
+
+For protected endpoints, include the authentication cookie:
+
+```
+Cookie: auth_token=your-auth-token
+```
+
+The module automatically handles cookie management for login/logout.
+
+## Rate Limiting
+
+Consider implementing rate limiting for these endpoints:
+
+- `/api/login`: Prevent brute force attacks
+- `/api/forgot-password`: Prevent email spam
+- `/api/reset-password`: Prevent token brute force
+
+## Next Steps
+
+- [Authentication Guide](/guide/authentication) - Learn about the authentication flow
+- [Password Reset Guide](/guide/password-reset) - Understand password reset functionality
+- [Components](/components/) - Use the provided Vue components