Skip to content

Commit 1797151

Browse files
committed
Improve release docs clarity and cut extension version 1.0.1
1 parent 9b6d5d2 commit 1797151

3 files changed

Lines changed: 36 additions & 10 deletions

File tree

INSTALL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Simple step-by-step instructions to install and use the Web2Comics Chrome extens
2222
```
2323

2424
4. **Select the extracted Web2Comics release folder**
25-
- Navigate to the extracted folder (for example `Web2Comics-v1.0`)
25+
- Navigate to the extracted folder (for example `Web2Comics-v1.0.1`)
2626
- Select the folder that contains `manifest.json`
2727
- Click "Select Folder" or "Open"
2828

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

178178
```
179-
Web2Comics-v1.0/
179+
Web2Comics-v1.0.1/
180180
├── manifest.json # Extension config
181181
├── popup/ # Main popup UI
182182
├── sidepanel/ # Comic viewer
@@ -200,4 +200,4 @@ Web2Comics-v1.0/
200200

201201
---
202202

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

README.md

Lines changed: 32 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -9,21 +9,29 @@ Web2Comics is a Chrome extension that:
99
- shows the result in a comic viewer side panel
1010
- saves history and exports a single composite comic image
1111

12+
## Quick Try (60 Seconds)
13+
14+
1. Download the latest release ZIP from the `Releases` page.
15+
2. Load it in Chrome via `chrome://extensions` -> `Load unpacked`.
16+
3. Enable and pin `Web2Comics` from the Extensions (puzzle) menu.
17+
4. Open the extension, configure a `Google Gemini` API key in `Options -> Providers`.
18+
5. Open any article, click `Create Comic`, and generate a 3-panel summary.
19+
1220
## Install (Easy ZIP Method)
1321

1422
### Option A: Download Release ZIP (recommended for non-developers)
1523

1624
Release links:
1725
- Releases page: https://github.com/ApartsinProjects/Web2Comics/releases
18-
- Current release (`v1.0`) ZIP: https://github.com/ApartsinProjects/Web2Comics/releases/download/v1.0/Web2Comics-v1.0-extension.zip
26+
- Current release (`v1.0.1`) ZIP: https://github.com/ApartsinProjects/Web2Comics/releases/download/v1.0.1/Web2Comics-v1.0.1-extension.zip
1927

2028
1. Open the repository `Releases` page on GitHub (link above).
21-
2. Download the latest release asset ZIP (for example `Web2Comics-v1.0-extension.zip`).
29+
2. Download the latest release asset ZIP (for example `Web2Comics-v1.0.1-extension.zip`).
2230
3. Extract the ZIP to a folder (for example `C:\Web2Comics`).
2331
4. Open Chrome and go to `chrome://extensions`.
2432
5. Turn on `Developer mode` (top-right).
2533
6. Click `Load unpacked`.
26-
7. Select the extracted folder that contains `manifest.json` (for example `Web2Comics-v1.0`).
34+
7. Select the extracted folder that contains `manifest.json` (for example `Web2Comics-v1.0.1`).
2735
8. In `chrome://extensions`, confirm the `Web2Comics` card is enabled (toggle ON).
2836
9. Open the Chrome Extensions menu (puzzle icon), find `Web2Comics`, and click the pin icon to show it in the toolbar.
2937
10. Web2Comics will open the Options page on first install so you can configure providers.
@@ -33,7 +41,7 @@ Note: `Code -> Download ZIP` downloads the full source repository (tests/scripts
3341
### Option B: Clone the repo (developer workflow)
3442

3543
```powershell
36-
git clone <your-repo-url>
44+
git clone https://github.com/ApartsinProjects/Web2Comics.git
3745
cd Web2Comics
3846
```
3947

@@ -51,10 +59,10 @@ After loading, confirm the extension is enabled and pin `Web2Comics` from the Ex
5159

5260
## Supported Providers
5361

54-
Text + image support (current implementation):
62+
Current provider support:
5563
- OpenAI
5664
- Google Gemini
57-
- Cloudflare Workers AI
65+
- Cloudflare Workers AI (text only in current extension build)
5866
- OpenRouter (model/account dependent)
5967
- Hugging Face Inference API
6068

@@ -82,6 +90,7 @@ Web2Comics also supports automatic fallback to other configured providers when a
8290
## Sample Comics (Real Provider Runs)
8391

8492
These examples were generated from the same `cnn.com` page using different providers and exported from Web2Comics as single PNG comic sheets.
93+
Some sample outputs may come from earlier probe/test runs and may not exactly match the current default provider capability matrix in the extension UI.
8594

8695
### OpenAI
8796

@@ -93,6 +102,8 @@ These examples were generated from the same `cnn.com` page using different provi
93102

94103
### Cloudflare Workers AI
95104

105+
Cloudflare support in the current extension is text generation only. This sample is kept as a reference artifact from prior provider testing/output workflows.
106+
96107
![Cloudflare CNN comic sample](samplecomics/2026-02-25_13-38-32/cloudflare-cnn-comic-sheet.png)
97108

98109
## First-Time Setup (Recommended Free-Tier Start)
@@ -118,6 +129,21 @@ The extension includes:
118129
For step-by-step key/token instructions, see:
119130
- `docs/user-manual.html` (appendix)
120131

132+
## Requirements / Compatibility
133+
134+
- Chrome / Chromium-based browser with Manifest V3 extension support
135+
- Chrome Side Panel support (used for the comic viewer)
136+
- Internet access to your selected AI provider APIs
137+
- At least one configured provider credential (`Options -> Providers`)
138+
139+
## Privacy / Data Handling
140+
141+
- Web2Comics runs locally in your browser extension (no project-hosted backend server).
142+
- To generate comics, the extension sends extracted page text, prompts, and generation requests to the AI provider(s) you configure.
143+
- API keys/tokens are stored in your browser extension storage on your machine.
144+
- Generated comics/history are stored locally unless you export/share them.
145+
- Review provider terms/privacy policies (OpenAI, Google Gemini, Cloudflare, OpenRouter, Hugging Face) before use on sensitive content.
146+
121147
## How To Use
122148

123149
1. Open a web page.

manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"manifest_version": 3,
33
"name": "Web2Comics",
4-
"version": "1.0",
4+
"version": "1.0.1",
55
"description": "Transform any web page into an engaging comic strip summary",
66
"icons": {
77
"16": "icons/icon16.png",

0 commit comments

Comments
 (0)