Skip to content

Commit daab39f

Browse files
Phase 8: Update README with Quickstart and Unified CLI documentation
1 parent 9ee852d commit daab39f

1 file changed

Lines changed: 25 additions & 9 deletions

File tree

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,36 @@
44

55
**The fastest way to start a CMS in Python.** Build production-grade sites with zero-config, modular themes, and a powerful content API.
66

7-
## 🚀 Get Started in 10 Seconds
7+
## 🚀 Quickstart
8+
9+
The new unified CLI makes it easier than ever to get started:
810

911
```bash
1012
pip install pythoncms
11-
pythoncms start mysite
12-
cd mysite
13-
# One command to rule them all (Coming in Phase 1)
14-
shopyo initialise
15-
flask shopyo-seed
16-
flask --debug run
13+
pythoncms start mysite --run
1714
```
1815

19-
Open your browser to: `http://127.0.0.1:5000/dashboard/`
20-
**Login:** `admin@domain.com` | `pass`
16+
This single command will:
17+
1. Create your project directory.
18+
2. Generate a secure `.env` file.
19+
3. Initialise the database.
20+
4. Seed the default admin user.
21+
5. Start the development server.
22+
23+
Open: `http://localhost:5000/dashboard`
24+
Login: `admin@domain.com` / `pass`
25+
26+
---
27+
28+
## 🛠️ Unified CLI Commands
29+
30+
Manage your entire project from one place:
31+
32+
- `pythoncms start <name>`: Create a new project.
33+
- `pythoncms run`: Start the dev server.
34+
- `pythoncms initialise`: Set up database and assets.
35+
- `pythoncms seed`: Reset default data.
36+
- `pythoncms --version`: Check your version.
2137

2238
---
2339

0 commit comments

Comments
 (0)