Skip to content

Commit 9b6d5d2

Browse files
committed
Fix install docs consistency and toolbar icon steps
1 parent 5f053c8 commit 9b6d5d2

2 files changed

Lines changed: 58 additions & 39 deletions

File tree

INSTALL.md

Lines changed: 51 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,49 @@
1-
# Web to Comic - Installation Guide
1+
# Web2Comics - Installation Guide
22

3-
Simple step-by-step instructions to the Web install and use to Comic Chrome extension.
3+
Simple step-by-step instructions to install and use the Web2Comics Chrome extension.
44

55
---
66

77
## Quick Start (5 minutes)
88

9-
### Step 1: Prepare Icons (If Needed)
10-
11-
The extension includes SVG icons. If Chrome shows warnings, create simple PNG icons:
12-
13-
1. Open https://svgtopng.com
14-
2. Upload each SVG file from the `icons/` folder
15-
3. Download the PNG versions (16x16, 48x48, 128x128)
16-
4. Replace the SVG files with PNG files
17-
18-
**Or use the included SVG icons directly** (works in most modern Chrome versions)
19-
20-
---
21-
22-
### Step 2: Load Extension in Chrome
9+
### Step 1: Load Extension in Chrome
2310

2411
1. **Open Chrome** and go to:
2512
```
2613
chrome://extensions/
2714
```
2815

29-
2. **Enable Developer Mode** (top-right corner)
30-
- Toggle the switch to ON
16+
2. **Enable Developer mode** (top-right corner)
17+
- Toggle the switch ON
3118

3219
3. **Click "Load unpacked"**
3320
```
3421
[+ Load unpacked]
3522
```
3623

37-
4. **Select the WebToComin folder**
38-
- Navigate to where you extracted the files
24+
4. **Select the extracted Web2Comics release folder**
25+
- Navigate to the extracted folder (for example `Web2Comics-v1.0`)
26+
- Select the folder that contains `manifest.json`
3927
- Click "Select Folder" or "Open"
4028

41-
5. **Done!** The extension should now appear in your extensions list
29+
5. **Confirm the extension is enabled**
30+
- In `chrome://extensions`, make sure the `Web2Comics` card toggle is ON
31+
32+
6. **Done!** The extension should now appear in your extensions list
4233

4334
---
4435

45-
### Step 3: Pin to Chrome Toolbar
36+
### Step 2: Show the Extension Icon in the Toolbar (Enable + Pin)
4637

47-
1. Click the puzzle piece icon (🧩) in Chrome's toolbar
48-
2. Find "Web to Comic"
49-
3. Click the **pin icon** to keep it visible
38+
1. Click the puzzle piece (Extensions) icon in Chrome's toolbar
39+
2. Find **Web2Comics**
40+
3. If it does not appear, confirm it is enabled in `chrome://extensions`
41+
4. Click the **pin** icon next to **Web2Comics** to keep it visible in the toolbar
42+
5. Click the Web2Comics toolbar icon to open the popup
5043

5144
---
5245

53-
### Step 4: Configure API Keys (Important!)
46+
### Step 3: Configure API Keys / Tokens (Important!)
5447

5548
The extension needs AI providers to generate comics. You must configure at least one:
5649

@@ -82,11 +75,24 @@ The extension needs AI providers to generate comics. You must configure at least
8275
- Same as above, but enter OpenAI key
8376
- Select your preferred models (GPT-4o, DALL-E 3)
8477

85-
#### Option C: Cloudflare Workers AI (Free)
78+
#### Option C: Cloudflare Workers AI (Account ID + API Token)
8679

87-
1. No API key needed for basic use
88-
2. Just select "Cloudflare Workers AI" as provider
89-
3. Note: Only supports text generation (no images)
80+
1. **Get your Cloudflare Account ID**
81+
- Open Cloudflare dashboard
82+
- Copy your Account ID from the account overview
83+
84+
2. **Create an API token**
85+
- Create a token with Workers AI / AI inference access for your account
86+
87+
3. **Configure in extension:**
88+
- Open **Options -> Providers**
89+
- Enter Cloudflare Account ID and API Token
90+
- Click `Validate`
91+
- Click `Save Providers`
92+
93+
4. **Note**
94+
- Cloudflare Workers AI is currently supported for text generation in this extension
95+
- Use another provider for image generation
9096

9197
---
9298

@@ -95,7 +101,7 @@ The extension needs AI providers to generate comics. You must configure at least
95101
### Generate Your First Comic
96102

97103
1. **Navigate to any article** (news, blog, etc.)
98-
2. **Click the extension icon** in toolbar
104+
2. **Click the Web2Comics extension icon** in the toolbar
99105
3. You'll see:
100106
- Extracted content preview
101107
- Panel count selector (3-12 panels)
@@ -120,6 +126,13 @@ The extension needs AI providers to generate comics. You must configure at least
120126
Solution: Make sure Developer mode is ON in chrome://extensions/
121127
```
122128

129+
### Extension icon not visible in toolbar
130+
```
131+
Solutions:
132+
- Open the Extensions (puzzle) menu and pin Web2Comics
133+
- Confirm Web2Comics is enabled in chrome://extensions
134+
```
135+
123136
### "API key not configured" error
124137
```
125138
Solution: Configure your API key in Options > Providers
@@ -154,7 +167,7 @@ Check chrome://extensions > Service worker for logs.
154167
## Uninstalling
155168

156169
1. Go to `chrome://extensions/`
157-
2. Find "Web to Comic"
170+
2. Find "Web2Comics"
158171
3. Click "Remove"
159172
4. Confirm
160173

@@ -163,7 +176,7 @@ Check chrome://extensions > Service worker for logs.
163176
## What's Included
164177

165178
```
166-
WebToComin/
179+
Web2Comics-v1.0/
167180
├── manifest.json # Extension config
168181
├── popup/ # Main popup UI
169182
├── sidepanel/ # Comic viewer
@@ -173,17 +186,18 @@ WebToComin/
173186
├── providers/ # AI providers
174187
├── shared/ # Shared code
175188
├── icons/ # Extension icons
176-
├── SPEC.md # Full specification
189+
├── docs/
190+
│ └── user-manual.html # User manual / help file
177191
└── INSTALL.md # This file
178192
```
179193

180194
---
181195

182196
## Need Help?
183197

184-
- **GitHub Issues:** Report bugs at https://github.com/anomalyco/opencode/issues
185-
- **Documentation:** See `SPEC.md` for technical details
198+
- **GitHub Issues:** Report bugs at https://github.com/ApartsinProjects/Web2Comics/issues
199+
- **Documentation:** See `docs/user-manual.html` for setup and usage details
186200

187201
---
188202

189-
*Version 1.0 | Last Updated: 2026-02-24*
203+
*Version 1.0 | Last Updated: 2026-02-26*

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,9 @@ Release links:
2424
5. Turn on `Developer mode` (top-right).
2525
6. Click `Load unpacked`.
2626
7. Select the extracted folder that contains `manifest.json` (for example `Web2Comics-v1.0`).
27-
8. Web2Comics will open the Options page on first install so you can configure providers.
28-
9. (Optional) Pin the extension from Chrome’s extensions menu (Chrome does not allow extensions to pin themselves automatically).
27+
8. In `chrome://extensions`, confirm the `Web2Comics` card is enabled (toggle ON).
28+
9. Open the Chrome Extensions menu (puzzle icon), find `Web2Comics`, and click the pin icon to show it in the toolbar.
29+
10. Web2Comics will open the Options page on first install so you can configure providers.
2930

3031
Note: `Code -> Download ZIP` downloads the full source repository (tests/scripts/docs included). Use the release asset ZIP for installation.
3132

@@ -37,6 +38,7 @@ cd Web2Comics
3738
```
3839

3940
Then load it in Chrome using the same `chrome://extensions` -> `Load unpacked` steps above.
41+
After loading, confirm the extension is enabled and pin `Web2Comics` from the Extensions (puzzle) menu so the toolbar icon is visible.
4042

4143
## What You Can Do
4244

@@ -175,6 +177,9 @@ HUGGINGFACE_INFERENCE_API_TOKEN=...
175177

176178
## Troubleshooting
177179

180+
- Extension icon not visible in toolbar:
181+
- Open the Chrome Extensions (puzzle) menu and pin `Web2Comics`
182+
- Confirm the extension is enabled in `chrome://extensions`
178183
- Provider not visible in popup:
179184
- Configure credentials in `Options -> Providers`
180185
- Click `Validate`

0 commit comments

Comments
 (0)