Skip to content

Commit 11b0881

Browse files
committed
Synchronize all platforms to v1.1.1
- Update README documentation to reference v1.1.1 consistently - Build and package v1.1.1 artifacts for Chrome and Firefox - Remove outdated v1.1.0 package files - Prepare for synchronized release across all platforms
1 parent 4697e03 commit 11b0881

10 files changed

+58
-14
lines changed

β€ŽREADME.mdβ€Ž

Lines changed: 58 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -15,21 +15,24 @@ A browser extension that detects blog posts and extracts linked blog content wit
1515
## 🌐 Browser Compatibility
1616

1717
- **Chrome**: Manifest V3 compatible
18-
- **Firefox**: Manifest V2 compatible
18+
- **Firefox**: Manifest V2 compatible
1919
- **Edge**: Chrome Web Store compatible
2020
- **Safari**: Not currently supported
2121

2222
## πŸ“‹ Requirements
2323

2424
### Operating System
25+
2526
- Windows 10+ or macOS 10.15+ or Ubuntu 18.04+
2627

2728
### Development Tools
29+
2830
- **Node.js**: 16.0.0 or higher
2931
- **npm**: 8.0.0 or higher
3032
- **Git**: 2.0.0 or higher (for cloning)
3133

3234
### Build Dependencies
35+
3336
- **webpack**: 5.89.0+ (JavaScript bundling)
3437
- **archiver**: 6.0.1+ (ZIP file creation)
3538
- **web-ext**: 9.1.0+ (Firefox XPI generation)
@@ -39,17 +42,20 @@ A browser extension that detects blog posts and extracts linked blog content wit
3942
## πŸš€ Installation
4043

4144
### 1. Clone Repository
45+
4246
```bash
4347
git clone https://github.com/codingnooob/blogbranch.git
4448
cd blogbranch
4549
```
4650

4751
### 2. Install Dependencies
52+
4853
```bash
4954
npm install
5055
```
5156

5257
### 3. Verify Installation
58+
5359
```bash
5460
npm run --help
5561
# Should show all available scripts
@@ -58,38 +64,49 @@ npm run --help
5864
## πŸ”§ Build Instructions
5965

6066
### Development Build
67+
6168
```bash
6269
npm run build:dev
6370
```
71+
6472
Creates development bundles with source maps and watches for changes.
6573

6674
### Production Build
75+
6776
```bash
6877
npm run build
6978
```
79+
7080
Creates optimized production bundles in `dist/` directory.
7181

7282
### Create Chrome Extension
83+
7384
```bash
7485
npm run package:chrome
7586
```
76-
Creates `blog-link-analyzer-v1.1.0.zip` ready for Chrome Web Store upload.
87+
88+
Creates `blog-link-analyzer-v1.1.1.zip` ready for Chrome Web Store upload.
7789

7890
### Create Firefox Extension
91+
7992
```bash
8093
npm run package:firefox
8194
```
82-
Creates `blog-link-analyzer-firefox-v1.1.0.zip` ready for Firefox Add-ons upload.
95+
96+
Creates `blog-link-analyzer-firefox-v1.1.1.zip` ready for Firefox Add-ons upload.
8397

8498
### Create All Package Formats
99+
85100
```bash
86101
npm run package:all-formats
87102
```
103+
88104
Creates all package formats:
89-
- Chrome ZIP: `blog-link-analyzer-v1.1.0.zip`
90-
- Chrome CRX: `blog-link-analyzer-v1.1.0.crx`
91-
- Firefox ZIP: `blog-link-analyzer-firefox-v1.1.0.zip`
92-
- Firefox XPI: `blog-link-analyzer-firefox-v1.1.0.xpi`
105+
106+
- Chrome ZIP: `blog-link-analyzer-v1.1.1.zip`
107+
- Chrome CRX: `blog-link-analyzer-v1.1.1.crx`
108+
- Firefox ZIP: `blog-link-analyzer-firefox-v1.1.1.zip`
109+
- Firefox XPI: `blog-link-analyzer-firefox-v1.1.1.xpi`
93110

94111
## πŸ“ Project Structure
95112

@@ -129,12 +146,14 @@ blogbranch/
129146
## πŸ€– AI Functionality
130147

131148
### Supported AI Providers
149+
132150
- **OpenAI**: GPT-4, GPT-3.5-turbo, GPT-3.5
133151
- **Anthropic**: Claude-3-sonnet, Claude-3-haiku, Claude-3-opus
134152
- **Ollama**: Local models (llama2, mistral, custom)
135153
- **Custom**: Any OpenAI-compatible API endpoint
136154

137155
### AI Features
156+
138157
- **Current Page Summary**: Summarize the blog post you're currently viewing
139158
- **Link Summaries**: Summarize individual blog posts from extracted links
140159
- **Batch Processing**: Summarize multiple links efficiently
@@ -145,64 +164,79 @@ blogbranch/
145164
## πŸ› οΈ Development
146165

147166
### Local Development
167+
148168
```bash
149169
npm run dev
150170
```
171+
151172
Starts development server with hot reloading and watches for file changes.
152173

153174
### Testing
175+
154176
```bash
155177
npm run test
156178
```
179+
157180
Runs the test suite with Jest framework.
158181

159182
### Linting
183+
160184
```bash
161185
npm run lint
162186
```
187+
163188
Checks code quality with ESLint.
164189

165190
### Type Checking
191+
166192
```bash
167193
npm run typecheck
168194
```
195+
169196
Validates TypeScript types (if applicable).
170197

171198
### Validation
199+
172200
```bash
173201
npm run validate
174202
```
203+
175204
Runs linting, type checking, and tests in sequence.
176205

177206
## πŸ“¦ Build Process
178207

179208
### Chrome Extension
209+
180210
1. **Bundle Creation**: Webpack bundles popup.js and dependencies
181211
2. **Manifest Processing**: Uses manifest.json (Manifest V3)
182212
3. **File Packaging**: Includes all necessary files in ZIP
183-
4. **Output**: `blog-link-analyzer-v1.1.0.zip`
213+
4. **Output**: `blog-link-analyzer-v1.1.1.zip`
184214

185215
### Firefox Extension
216+
186217
1. **Structure Build**: Copies files to build-firefox/ directory
187218
2. **Manifest Conversion**: Converts to Manifest V2 format
188219
3. **Utils Organization**: Places AI files in utils/ directory
189220
4. **File Packaging**: Creates ZIP with Firefox-specific structure
190221
5. **XPI Generation**: Uses web-ext to create signed XPI
191-
6. **Output**: `blog-link-analyzer-firefox-v1.1.0.xpi`
222+
6. **Output**: `blog-link-analyzer-firefox-v1.1.1.xpi`
192223

193224
### Output Files
194-
- **Chrome ZIP**: `blog-link-analyzer-v1.1.0.zip` (~78KB)
195-
- **Chrome CRX**: `blog-link-analyzer-v1.1.0.crx` (~78KB)
196-
- **Firefox ZIP**: `blog-link-analyzer-firefox-v1.1.0.zip` (~78KB)
197-
- **Firefox XPI**: `blog-link-analyzer-firefox-v1.1.0.xpi` (~78KB)
225+
226+
- **Chrome ZIP**: `blog-link-analyzer-v1.1.1.zip` (~78KB)
227+
- **Chrome CRX**: `blog-link-analyzer-v1.1.1.crx` (~78KB)
228+
- **Firefox ZIP**: `blog-link-analyzer-firefox-v1.1.1.zip` (~78KB)
229+
- **Firefox XPI**: `blog-link-analyzer-firefox-v1.1.1.xpi` (~78KB)
198230

199231
## πŸ”§ Configuration
200232

201233
### Environment Variables
234+
202235
- **NODE_ENV**: Set to 'production' for optimized builds
203236
- **EXTENSION_VERSION**: Automatically set from package.json
204237

205238
### Customization
239+
206240
- **AI Providers**: Configure in extension settings
207241
- **API Keys**: Set in extension popup settings
208242
- **Model Selection**: Choose specific models per provider
@@ -213,19 +247,22 @@ Runs linting, type checking, and tests in sequence.
213247
### Common Build Issues
214248

215249
#### Permission Denied
250+
216251
```bash
217252
# Fix: Ensure proper file permissions
218253
chmod +x scripts/*.js
219254
```
220255

221256
#### Missing Dependencies
257+
222258
```bash
223259
# Fix: Clean install
224260
rm -rf node_modules package-lock.json
225261
npm install
226262
```
227263

228264
#### Web-ext Not Found
265+
229266
```bash
230267
# Fix: Install globally
231268
npm install -g web-ext
@@ -234,25 +271,29 @@ npm install -g web-ext
234271
### Firefox-Specific Issues
235272

236273
#### Manifest Validation Errors
274+
237275
- **Content Scripts**: Ensure all files exist in content/ directory
238276
- **Icons**: Verify all icon sizes are present in icons/ directory
239277
- **Permissions**: Check required permissions in manifest-firefox.json
240278

241279
#### XPI Generation Fails
280+
242281
- **Node Version**: Ensure Node.js 16+ is installed
243282
- **Build Directory**: Clean build-firefox/ directory first
244283
- **Web-ext Version**: Update to latest web-ext version
245284

246285
### Chrome-Specific Issues
247286

248287
#### Manifest V3 Errors
288+
249289
- **Service Worker**: Ensure background/service-worker.js exists
250290
- **Action Handlers**: Verify proper action API usage
251291
- **CSP Rules**: Check content security policy compliance
252292

253293
## 🀝 Contributing
254294

255295
### Development Workflow
296+
256297
1. Fork the repository
257298
2. Create a feature branch: `git checkout -b feature-name`
258299
3. Make changes and test thoroughly
@@ -262,6 +303,7 @@ npm install -g web-ext
262303
7. Create pull request
263304

264305
### Code Style
306+
265307
- **Indentation**: 2 spaces
266308
- **Quotes**: Single quotes for strings
267309
- **Trailing Commas**: Required in objects/arrays
@@ -282,17 +324,19 @@ MIT License - see [LICENSE](LICENSE) file for details.
282324

283325
## πŸ“ˆ Version History
284326

327+
- **v1.1.1**: Version synchronization across all platforms, bug fixes
285328
- **v1.1.0**: AI summarization functionality, project structure optimization
286329
- **v1.0.2**: Initial release with basic blog detection
287330
- **v1.0.1**: Beta testing release
288331

289332
## πŸ“ž Support
290333

291334
For issues, questions, or contributions:
335+
292336
- **GitHub Issues**: https://github.com/codingnooob/blogbranch/issues
293337
- **Documentation**: See additional .md files in repository
294338
- **Privacy Policy**: See [PRIVACY.md](PRIVACY.md)
295339

296340
---
297341

298-
**Built with ❀️ for the blogging community**
342+
**Built with ❀️ for the blogging community**

β€Žblog-link-analyzer-1.1.1.crxβ€Ž

0 Bytes
Binary file not shown.

β€Žblog-link-analyzer-1.1.1.zipβ€Ž

0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.
-76.7 KB
Binary file not shown.
-76.7 KB
Binary file not shown.
0 Bytes
Binary file not shown.
-76.6 KB
Binary file not shown.
-76.6 KB
Binary file not shown.
-76.6 KB
Binary file not shown.

0 commit comments

Comments
Β (0)