ViberLu commited on
Commit
0b9a13c
·
verified ·
1 Parent(s): 4227f97

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +61 -2
README.md CHANGED
@@ -1,10 +1,11 @@
 
1
  ---
2
  title: GitHub Graphics Generator
3
  emoji: 🎨
4
  colorFrom: blue
5
  colorTo: purple
6
  sdk: gradio
7
- sdk_version: 6.2.0
8
  app_file: app.py
9
  pinned: false
10
  license: mit
@@ -51,4 +52,62 @@ The result is **consistent, readable, and reusable graphics**.
51
  ## How to Use
52
 
53
  1. Paste a GitHub repository URL
54
- Example:
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+
2
  ---
3
  title: GitHub Graphics Generator
4
  emoji: 🎨
5
  colorFrom: blue
6
  colorTo: purple
7
  sdk: gradio
8
+ sdk_version: 4.44.1
9
  app_file: app.py
10
  pinned: false
11
  license: mit
 
52
  ## How to Use
53
 
54
  1. Paste a GitHub repository URL
55
+ Example:
56
+
57
+ https://github.com/owner/repo
58
+
59
+ 2. Choose:
60
+ - Style (Modern, Minimal, Professional)
61
+ - Color scheme
62
+ - Output size
63
+
64
+ 3. Click **Generate**
65
+
66
+ 4. Download the generated PNG
67
+
68
+ ---
69
+
70
+ ## Supported Models
71
+
72
+ The following Hugging Face Inference API models are supported:
73
+
74
+ - `stabilityai/stable-diffusion-xl-base-1.0`
75
+ - `runwayml/stable-diffusion-v1-5`
76
+
77
+ > Note: Diffusers-only models (e.g. SDXL-Lightning) are intentionally not used to ensure compatibility with Hugging Face Spaces.
78
+
79
+ ---
80
+
81
+ ## Technical Overview
82
+
83
+ - **Frontend**: Gradio (Blocks API)
84
+ - **Backend**: Python
85
+ - **AI Inference**: Hugging Face `InferenceClient`
86
+ - **Layout & Text Rendering**: Pillow (PIL)
87
+ - **Data Source**: GitHub REST API
88
+
89
+ ---
90
+
91
+ ## Environment Variables
92
+
93
+ Optional but recommended:
94
+
95
+ ```env
96
+ HUGGINGFACE_TOKEN=hf_xxxxxxxxxxxxxxxxx
97
+
98
+ This enables:
99
+ • Higher rate limits
100
+ • Faster inference
101
+ • Access to gated models (if applicable)
102
+
103
+
104
+
105
+ Known Limitations
106
+ • AI does not render text or logos
107
+ • GitHub API rate limits apply without a token
108
+ • Image generation speed depends on model availability
109
+
110
+
111
+
112
+ License
113
+