added more docs
This commit is contained in:
10
README.md
10
README.md
@@ -6,6 +6,7 @@ MiauInv is a secure, light-weight inventory, stock, and project allocation track
|
||||
|
||||
* [Technical Specifications](#technical-specifications)
|
||||
* [Architecture Overview](#architecture-overview)
|
||||
* [Detailed Documentation](#detailed-documentation)
|
||||
* [Configuration](#configuration)
|
||||
* [Configuration File (config.yaml)](#configuration-file-configyaml)
|
||||
* [Environment Variables](#environment-variables)
|
||||
@@ -43,6 +44,15 @@ MiauInv splits responsibility cleanly across modularized architecture packages:
|
||||
|
||||
---
|
||||
|
||||
---
|
||||
|
||||
## Detailed Documentation
|
||||
|
||||
For deep dives into specific subsystems, database layouts, and security mechanisms, please refer to the dedicated documentation files:
|
||||
|
||||
* **[Database Schema & Integrity](docs/DATABASE.md):** Comprehensive breakdown of the SQLite table structures, fields, and foreign key relations.
|
||||
* **[Authentication Architecture](docs/AUTHENTICATION.md):** Detailed explanation of the dual-token rotation flow, JWT lifecycle, and frontend loop protection.
|
||||
|
||||
## Configuration
|
||||
|
||||
The system uses a combination of a structural JSON configuration file and environment variables for system runtime flags.
|
||||
|
||||
Reference in New Issue
Block a user