DevmanMikey commited on
Commit
5479b70
Β·
1 Parent(s): d63d759

Update README with comprehensive documentation and deployment guide

Browse files
Files changed (1) hide show
  1. README.md +28 -5
README.md CHANGED
@@ -12,10 +12,33 @@ license: apache-2.0
12
 
13
  # Dynamic Components Generator
14
 
15
- Generate and render interactive web components using AI, with OpenPlatform integration for seamless embedding.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
16
 
17
  ## Features
18
- - AI-powered component generation via Qwen3-Coder API
19
- - Live rendering in web sandbox
20
- - PostMessage support for parent communication
21
- - Deployable to Hugging Face Spaces
 
 
 
 
12
 
13
  # Dynamic Components Generator
14
 
15
+ This project generates AI-powered web components with seamless OpenPlatform integration.
16
+
17
+ ## Quick Start
18
+
19
+ 1. **Local Development**
20
+ ```bash
21
+ pip install -r requirements.txt
22
+ python app.py
23
+ ```
24
+
25
+ 2. **Deploy to Hugging Face Spaces**
26
+ - Create a new Space on Hugging Face
27
+ - Connect this repository
28
+ - Spaces will automatically detect the `app.py` and deploy
29
+
30
+ ## Architecture
31
+
32
+ - **AI Generation**: Uses Qwen3-Coder via Spaces API
33
+ - **Rendering**: WebSandbox with React support
34
+ - **Communication**: postMessage for parent integration
35
+ - **Storage**: Ready for OpenGist integration
36
 
37
  ## Features
38
+
39
+ - βœ… Component generation via natural language prompts
40
+ - βœ… Live preview in sandbox environment
41
+ - βœ… postMessage integration for parent apps
42
+ - βœ… React ecosystem support
43
+ - πŸ”„ OpenGist storage (planned)
44
+ - πŸ”„ Advanced component libraries (planned)