Skip to content

Commit 7251447

Browse files
chore(docs): update README with documentation link and standard package structure
1 parent 737cd16 commit 7251447

File tree

3 files changed

+89
-17
lines changed

3 files changed

+89
-17
lines changed

README.md

Lines changed: 79 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,88 @@
11
# AuthKit
2+
23
![Tests](https://github.com/Xultech-LTD/auth-kit/actions/workflows/tests.yml/badge.svg)
34
![License](https://img.shields.io/github/license/Xultech-LTD/auth-kit)
4-
![PHP](https://img.shields.io/badge/php-%5E8.2-blue)
5-
![Laravel](https://img.shields.io/badge/laravel-12-red)
6-
![Laravel](https://img.shields.io/badge/laravel-13-green)
5+
![PHP](https://img.shields.io/badge/php-%5E8.3-blue)
6+
![Laravel](https://img.shields.io/badge/laravel-12.x-red)
7+
![Laravel](https://img.shields.io/badge/laravel-13.x-green)
8+
9+
AuthKit is a reusable, configuration-driven authentication package for Laravel applications.
10+
11+
It provides a complete authentication system with Blade-based UI, flexible configuration, and extensible flows — without forcing a fixed implementation.
12+
13+
---
14+
15+
## 🚀 Documentation
16+
17+
Full documentation is available here:
718

8-
Reusable Laravel auth kit package with Blade UI, themes, email verification, two-factor authentication, password reset, and rate limiting.
19+
👉 **https://xultech-ltd.github.io/auth-kit/**
920

10-
## Status
21+
The documentation covers:
1122

12-
AuthKit is currently in active development and not yet published to Packagist.
23+
- Installation
24+
- Configuration
25+
- Authentication flows
26+
- UI customization
27+
- Extensibility and overrides
28+
- Security features
1329

14-
## Features
30+
---
1531

16-
- Login / registration
17-
- Email verification (link or token)
18-
- Password reset (link or token)
19-
- Two-factor authentication(TOTP supported - able to extend)
32+
## ✨ Features
33+
34+
- Authentication (login & registration)
35+
- Email verification (link or token-based)
36+
- Password reset (link or token-based)
37+
- Two-factor authentication (TOTP, extensible drivers)
2038
- Blade-based UI components
21-
- Theme support
22-
- Rate limiting configuration
23-
- Controller and validation overrides
39+
- Theme and UI customization support
40+
- Fully configuration-driven architecture
41+
- Route, controller, and validation overrides
42+
- Rate limiting and security controls
43+
44+
---
45+
46+
## 📦 Installation
47+
48+
> ⚠️ AuthKit is currently in active development.
49+
50+
Once published:
51+
52+
```bash
53+
composer require xul/auth-kit
54+
```
55+
Then follow the installation guide in the documentation.
56+
57+
## ⚙️ Configuration Philosophy
58+
59+
AuthKit is built around a configuration-first approach.
60+
61+
Instead of hardcoding behavior, you can control:
62+
63+
- authentication flows
64+
- route structure and naming
65+
- validation and payload mapping
66+
- UI rendering and form schemas
67+
- security features (verification, 2FA, confirmations)
68+
- frontend behavior and themes
69+
70+
This allows you to adapt AuthKit to your application without modifying package internals.
71+
72+
## 🧪 Testing
73+
```bash
74+
composer test
75+
```
76+
77+
## 🤝 Contributing
78+
79+
Contributions are welcome.
80+
81+
Please:
82+
- open issues for bugs or feature requests
83+
- submit pull requests for improvements
84+
- follow existing code style and structure
85+
86+
- ## 📄 License
87+
88+
AuthKit is open-sourced software licensed under the MIT license.

composer.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,18 @@
3030
],
3131
"require": {
3232
"php": "^8.3",
33-
"illuminate/support": "^12.0|^13.0",
33+
"illuminate/auth": "^12.0|^13.0",
34+
"illuminate/cache": "^12.0|^13.0",
35+
"illuminate/contracts": "^12.0|^13.0",
36+
"illuminate/events": "^12.0|^13.0",
37+
"illuminate/http": "^12.0|^13.0",
38+
"illuminate/notifications": "^12.0|^13.0",
39+
"illuminate/queue": "^12.0|^13.0",
3440
"illuminate/routing": "^12.0|^13.0",
41+
"illuminate/session": "^12.0|^13.0",
42+
"illuminate/support": "^12.0|^13.0",
43+
"illuminate/validation": "^12.0|^13.0",
3544
"illuminate/view": "^12.0|^13.0",
36-
"livewire/blaze": "^1.0",
3745
"bacon/bacon-qr-code": "^3.0"
3846
},
3947
"require-dev": {

docs/.vitepress/config.mjs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ export default defineConfig({
99
nav: [
1010
{ text: 'Home', link: '/' },
1111
{ text: 'Installation', link: '/installation' },
12-
{ text: 'Architecture', link: '/architecture/overview' },
1312
{ text: 'GitHub', link: 'https://github.com/Xultech-LTD/auth-kit' }
1413
],
1514

0 commit comments

Comments
 (0)