Skip to content

Commit 831b604

Browse files
"Fixed README to reflect I actually built this from scratch, not just copied OpenCart config."
1 parent 96ce6e2 commit 831b604

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ product SKUs.
2222
## What Makes Spindle Different?
2323

2424
- **No eCommerce bloat** — no carts, no payments, no inventory logic
25-
- **Dynamic subdomain routing** — serve multi-site content from folders with no config
25+
- **Dynamic subdomain routing** — serve multi-site content from folders
26+
- **Shared folders and models** — Use a shared folder for subdomains and other content
2627
- **Familiar MVC structure** — but focused purely on content-first deployments
2728
- **No Composer required** — works out-of-the-box without external dependencies
2829
- **Full codebase access** — nothing obfuscated, everything hackable
@@ -74,13 +75,17 @@ composer install
7475
## Directory Layout
7576

7677
* `public_html/` – public web root
78+
* `public_html/app` – Main website
79+
* `public_html/cdn` – CDN folder for faster load speeds (Set up with VHOST or cloudflare caching)
80+
* `public_html/data` – Manifest data and images (if required)
81+
* `public_html/subDomains` – folder-based routing for subdomains
82+
* `public_html/shared` – Shared utilities (Models, Views, Controllers)
83+
* `public_html/system` – All system components
7784
* `storage/` – configs, logs, cache (outside web root)
78-
* `extensions/` – custom modules & logic
79-
* `subDomains/` – folder-based routing for subdomains
8085

8186
---
8287

83-
## Why Spindle?
88+
## Why Spindle?
8489

8590
> "OpenCart Without the Cart."
8691
@@ -94,16 +99,15 @@ baggage. This is a toolkit for making dashboards, wikis, documentation hubs, and
9499
* [x] Rewrite base routing and MVC to remove cart logic
95100
* [x] Subdomain-to-folder routing via `.htaccess`
96101
* [x] Directory security separation
97-
* [ ] CLI tooling for module generators
98-
* [ ] Optional flat-file mode (no DB)
99-
* [ ] Admin UI theming system
100-
* [ ] Fully API-driven mode (optional headless)
102+
* [ ] Everything else
103+
* [ ] Example usages
104+
* [ ] Future updates
101105

102106
---
103107

104108
## License
105109

106-
GPLv3 — free to use, fork, modify, and redistribute.
110+
GPLv3 — free to use, fork, modify, and redistribute, would be MIT, but have to stick with opencart's license.
107111

108112
> Spindle is yours now. Hack it.
109113

0 commit comments

Comments
 (0)