Skip to content

Commit 391ddbb

Browse files
committed
update read me
1 parent 335d037 commit 391ddbb

File tree

1 file changed

+58
-33
lines changed

1 file changed

+58
-33
lines changed

README.md

Lines changed: 58 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,31 @@
11
# CCUX — AI-Powered Website Generator
22

3-
Generate professional landing pages and complete websites from your terminal using Claude AI.
3+
Generate multi-page, conversion-optimized websites directly from your terminal.
4+
CCUX uses **Claude AI** to transform a simple product description into production-ready code — no design tools required.
45

5-
## What CCUX Does
6+
---
67

7-
CCUX transforms your product description into conversion-optimized websites through professional UX design methodology. Simply describe your product, and get production-ready HTML or React components in minutes.
8+
## Features
9+
10+
- **One-line generation** — describe your product and get a landing page or full site in minutes
11+
- **Professional themes** — choose from 13 styles (minimal, corporate, brutalist, animated, etc.)
12+
- **Precision editing** — regenerate specific sections without rebuilding everything
13+
- **Interactive workflow** — guided wizard for multi-page sites, live editing, and theme switching
14+
- **Production-ready output** — responsive HTML or React components with TailwindCSS, SEO, and accessibility
15+
16+
---
817

918
## Installation
1019

1120
```bash
1221
pip install ccux
1322
```
1423

15-
**Prerequisites:** Claude CLI and Python 3.9+. Get Claude CLI from [claude.ai/code](https://claude.ai/code).
24+
**Prerequisites:**
25+
- Python 3.9+
26+
- [Claude CLI](https://claude.ai/code) (used for AI generation)
27+
28+
---
1629

1730
## Getting Started
1831

@@ -23,12 +36,12 @@ ccux init
2336
```
2437

2538
The interactive terminal app provides:
26-
- Guided website creation wizard
27-
- Visual project management
28-
- Live section editing and theme switching
29-
- Multi-page website generation
30-
- Form management and customization
31-
- Press ESC anytime to exit
39+
- Guided website creation wizard
40+
- Visual project management
41+
- Live section editing and theme switching
42+
- Multi-page website generation
43+
- Form management and customization
44+
- Press `ESC` anytime to exit
3245

3346
### Command Line Usage
3447

@@ -46,33 +59,39 @@ ccux regen --section hero,pricing
4659
ccux gen --desc-file product.pdf --theme brutalist
4760
```
4861

62+
---
63+
4964
## Commands
5065

51-
| Command | Description |
52-
|---------|-------------|
53-
| `ccux init` | **Interactive app** - Guided website creation |
54-
| `ccux gen` | Generate single landing page |
55-
| `ccux multipage` | Generate complete multi-page website |
56-
| `ccux regen` | Update specific sections of existing pages |
57-
| `ccux projects` | List existing projects |
58-
| `ccux help` | Get detailed help for any topic |
66+
| Command | Description |
67+
|------------------|-------------------------------------|
68+
| `ccux init` | Interactive wizard for new projects |
69+
| `ccux gen` | Generate a single landing page |
70+
| `ccux multipage` | Generate a complete multi-page site |
71+
| `ccux regen` | Update specific sections |
72+
| `ccux projects` | List existing projects |
73+
| `ccux help` | Detailed help for any topic |
74+
75+
---
5976

6077
## What You Get
6178

62-
**Professional Quality Output:**
63-
- Production-ready HTML or React components
64-
- Mobile-responsive design with TailwindCSS
65-
- SEO optimization and accessibility features
66-
- Clean, semantic code structure
79+
### Professional Quality Output
80+
- Production-ready HTML or React components
81+
- Mobile-responsive design with TailwindCSS
82+
- SEO optimization and accessibility features
83+
- Clean, semantic code structure
6784

68-
**AI Design Process:**
69-
- Automatic competitor analysis and research
70-
- Professional UX methodology (12-phase process)
71-
- User personas and conversion optimization
72-
- Strategic copywriting and visual design
85+
### AI Design Process
86+
- Automatic competitor analysis and research
87+
- Structured UX methodology for layouts and flows
88+
- Conversion-optimized copywriting
89+
- Consistent visual design across 13 themes
7390

74-
**13 Design Themes:**
75-
From minimal and corporate to brutalist, animated, and illustrated styles.
91+
### 13 Design Themes
92+
From minimal and corporate to brutalist, animated, and illustrated styles.
93+
94+
---
7695

7796
## Examples
7897

@@ -91,6 +110,8 @@ ccux multipage --desc "SaaS platform with features, pricing, and about pages"
91110
ccux regen --section hero,pricing
92111
```
93112

113+
---
114+
94115
## View Your Pages
95116

96117
```bash
@@ -99,8 +120,12 @@ python -m http.server 3000
99120
# Open http://localhost:3000
100121
```
101122

123+
---
124+
102125
## Links
103126

104-
- **PyPI:** [pypi.org/project/ccux](https://pypi.org/project/ccux/)
105-
- **Claude CLI:** [claude.ai/code](https://claude.ai/code)
106-
- **Help:** Run `ccux help` for detailed documentation
127+
- **PyPI:** [pypi.org/project/ccux](https://pypi.org/project/ccux/)
128+
- **Claude CLI:** [claude.ai/code](https://claude.ai/code)
129+
- **Help:** Run `ccux help` for detailed documentation
130+
131+
---

0 commit comments

Comments
 (0)