mirror of
https://github.com/harivansh-afk/betterNAS.git
synced 2026-04-15 09:01:13 +00:00
edit readme
This commit is contained in:
parent
6b7e201066
commit
4f46d2f3df
1 changed files with 4 additions and 22 deletions
26
README.md
26
README.md
|
|
@ -1,27 +1,9 @@
|
|||
# betterNAS
|
||||
|
||||
<img width="723" height="354" alt="image" src="https://github.com/user-attachments/assets/4e64fa91-315b-4a31-b191-d54ed1862ff7" />
|
||||
|
||||
## Start here
|
||||
|
||||
The canonical repo contract lives in [docs/architecture.md](/home/rathi/Documents/GitHub/betterNAS/docs/architecture.md).
|
||||
|
||||
Read these in order:
|
||||
|
||||
1. [docs/architecture.md](/home/rathi/Documents/GitHub/betterNAS/docs/architecture.md)
|
||||
2. [docs/01-nas-node.md](/home/rathi/Documents/GitHub/betterNAS/docs/01-nas-node.md)
|
||||
3. [docs/02-control-plane.md](/home/rathi/Documents/GitHub/betterNAS/docs/02-control-plane.md)
|
||||
4. [docs/03-local-device.md](/home/rathi/Documents/GitHub/betterNAS/docs/03-local-device.md)
|
||||
5. [docs/04-cloud-web-layer.md](/home/rathi/Documents/GitHub/betterNAS/docs/04-cloud-web-layer.md)
|
||||
6. [docs/05-build-plan.md](/home/rathi/Documents/GitHub/betterNAS/docs/05-build-plan.md)
|
||||
7. [docs/references.md](/home/rathi/Documents/GitHub/betterNAS/docs/references.md)
|
||||
|
||||
## Current direction
|
||||
|
||||
- betterNAS is WebDAV-first for mount mode.
|
||||
- the control plane is the system of record.
|
||||
- the NAS node serves bytes directly whenever possible.
|
||||
- Nextcloud is an optional cloud/web adapter, not the product center.
|
||||
- control-plane owns policy and identity (decides)
|
||||
- node-agent owns file serving (serves)
|
||||
- web owns UX (consumer facing)
|
||||
- nextcloud-app is optional adapter only for cloud storage in s3 n shit
|
||||
|
||||
## Monorepo
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue