Skip to content

Commit 3103c9f

Browse files
author
Lukas Geiger
committed
docs: improve RSS-BOOK discoverability
1 parent 5407539 commit 3103c9f

4 files changed

Lines changed: 81 additions & 4 deletions

File tree

CHANGELOG.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
## [Unreleased]
44

55
### Added
6+
- Added `llms.txt` with canonical links, feature summary, developer commands, and search phrases for crawler/LLM discovery.
7+
- Added README links to the live Chrome Web Store listing and GitHub Releases page.
8+
- Added README product screenshot gallery using the existing store screenshots.
69
- Added options-page lifecycle diagnostics for service-worker boot, alarm cadence, and recent update-cycle activity.
710
- Added automated light/dark theme coverage for popup and options CSS variables.
811
- Added a read-only GitHub Actions CI workflow for the Node test suite.
@@ -19,10 +22,11 @@
1922
- Normalized the German locale file to real UTF-8 Umlaute instead of escaped code points.
2023

2124
### Changed
25+
- Clarified README positioning for bookmark-based RSS reader and Chrome Web Store search queries.
2226
- Added repository line-ending rules, explicitly ignored local pytest caches, and updated the README Edge packaging note.
2327

2428
### Verified
25-
- `npm test` now covers 33 dependency-free Node tests, including the 10-feed parser matrix, CDATA cleanup, theme, service-worker scheduling, lifecycle diagnostics, and package-content coverage.
29+
- `npm test` now covers 34 dependency-free Node tests, including the 10-feed parser matrix, CDATA cleanup, theme, service-worker scheduling, lifecycle diagnostics, and package-content coverage.
2630
- `npm run package` creates `dist/RSS-BOOK-v1.1.2-edge.zip` with the Manifest V3 runtime files plus license/privacy docs.
2731

2832
## [1.1.2] — 2026-04-30

README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,13 @@
11
# RSS-BOOK
22

3+
Bookmark-based RSS reader browser extension for Chrome, Edge, Brave and Vivaldi.
4+
35
RSS-BOOK is a privacy-first RSS and Atom feed reader for Chromium browsers.
46
Instead of creating another account or cloud database, it saves feed entries as
57
browser bookmarks so Chrome, Edge, Brave and Vivaldi sync can carry them across
6-
devices.
8+
devices. It is built for readers who want a lightweight Chrome Web Store RSS
9+
extension with OPML import/export, feed discovery, notifications, dark mode and
10+
no tracking.
711

812
![RSS-BOOK](assets/social-preview.png)
913

@@ -18,6 +22,15 @@ devices.
1822

1923
---
2024

25+
## Get RSS-BOOK
26+
27+
- **Chrome Web Store:** [Install RSS-BOOK](https://chromewebstore.google.com/detail/rss-book/aednfjhookicnhcjhjifbaepglinbdli)
28+
- **GitHub Releases:** [Download the extension ZIP](https://github.com/file-bricks/RSS-BOOK/releases)
29+
- **Source code:** [file-bricks/RSS-BOOK](https://github.com/file-bricks/RSS-BOOK)
30+
31+
RSS-BOOK is also usable by sideloading the unpacked repository in Chrome, Edge,
32+
Brave or Vivaldi.
33+
2134
## How it works
2235

2336
1. Add RSS or Atom feed URLs in the options page
@@ -41,6 +54,11 @@ Your feeds live in your bookmarks — accessible everywhere your browser syncs,
4154

4255
## Install
4356

57+
### Chrome Web Store
58+
59+
Install the published extension from the
60+
[Chrome Web Store](https://chromewebstore.google.com/detail/rss-book/aednfjhookicnhcjhjifbaepglinbdli).
61+
4462
### From GitHub (Chrome, Edge, Brave, Vivaldi)
4563

4664
1. Download or clone this repository
@@ -52,6 +70,13 @@ Your feeds live in your bookmarks — accessible everywhere your browser syncs,
5270

5371
Create the upload-ready ZIP with `npm run package`. The generated archive stays local under `dist/` and is intentionally ignored by git.
5472

73+
## Product Screenshots
74+
75+
![RSS-BOOK popup with subscribed feeds](assets/screenshot-1-popup.png)
76+
![RSS-BOOK options page with feed settings](assets/screenshot-2-options.png)
77+
![RSS-BOOK browser bookmark folders](assets/screenshot-3-folders.png)
78+
![RSS-BOOK saved feed entries as bookmarks](assets/screenshot-4-entries.png)
79+
5580
## Usage
5681

5782
**Popup** — click the extension icon to see your feeds and trigger a manual update.
@@ -67,7 +92,7 @@ Create the upload-ready ZIP with `npm run package`. The generated archive stays
6792

6893
## Development
6994

70-
RSS-BOOK has no bundling step. The repository includes 33 dependency-free Node tests for parser behavior, a 10-fixture RSS/Atom feed matrix, CDATA cleanup, OPML, storage, bookmark cleanup, feed discovery, folder export, store assets, service-worker scheduling, lifecycle diagnostics, light/dark theme CSS coverage, and Edge package contents:
95+
RSS-BOOK has no bundling step. The repository includes 34 dependency-free Node tests for parser behavior, a 10-fixture RSS/Atom feed matrix, CDATA cleanup, OPML, storage, bookmark cleanup, feed discovery, folder export, store assets, service-worker scheduling, lifecycle diagnostics, light/dark theme CSS coverage, and Edge package contents:
7196

7297
```bash
7398
npm test
@@ -132,6 +157,12 @@ RSS-BOOK/
132157
- [x] Bookmark folder survives rename/move (tracked by ID)
133158
- [x] Option to delete bookmarks on unsubscribe
134159

160+
## Discovery keywords
161+
162+
`RSS reader`, `Atom feed reader`, `Chrome RSS extension`, `bookmark-based RSS reader`,
163+
`browser bookmark feed reader`, `Manifest V3 RSS`, `OPML import export`,
164+
`privacy-first RSS reader`, `no-account feed reader`, `Edge RSS extension`.
165+
135166
## License
136167

137168
[MIT](LICENSE)

llms.txt

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# RSS-BOOK
2+
3+
> RSS-BOOK is a privacy-first Manifest V3 browser extension for Chrome, Edge,
4+
> Brave and Vivaldi. It turns RSS and Atom feed entries into browser bookmarks
5+
> instead of storing them in a cloud account.
6+
7+
## Canonical links
8+
9+
- GitHub: https://github.com/file-bricks/RSS-BOOK
10+
- Chrome Web Store: https://chromewebstore.google.com/detail/rss-book/aednfjhookicnhcjhjifbaepglinbdli
11+
- Releases: https://github.com/file-bricks/RSS-BOOK/releases
12+
- Privacy policy: https://github.com/file-bricks/RSS-BOOK/blob/main/PRIVACY_POLICY.md
13+
14+
## What it does
15+
16+
- Saves RSS and Atom feed entries as browser bookmarks.
17+
- Uses local browser storage for configuration and cache metadata.
18+
- Supports OPML import/export, feed discovery, notifications and dark mode.
19+
- Avoids accounts, telemetry, analytics and third-party proxy services.
20+
- Runs as a dependency-free Chromium Manifest V3 extension.
21+
22+
## Developer commands
23+
24+
```bash
25+
npm test
26+
npm run package
27+
```
28+
29+
## Important files
30+
31+
- `manifest.json` - Chromium Manifest V3 extension metadata.
32+
- `sw.js` - service worker for scheduled feed updates.
33+
- `lib/rss.js` - RSS/Atom parser.
34+
- `lib/bookmarks.js` - bookmark folder and item management.
35+
- `ui/popup.html` / `ui/options.html` - extension interface.
36+
- `_locales/en/messages.json` and `_locales/de/messages.json` - UI strings.
37+
38+
## Search phrases
39+
40+
RSS reader browser extension, Chrome RSS extension, bookmark-based RSS reader,
41+
privacy-first RSS reader, Manifest V3 RSS reader, OPML feed reader, Edge RSS
42+
extension, Atom feed reader for Chromium.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
"version": "1.1.2",
44
"private": true,
55
"type": "module",
6-
"description": "Manifest V3 RSS/Atom to bookmarks browser extension.",
6+
"description": "Privacy-first Manifest V3 RSS/Atom reader that saves feed entries as browser bookmarks.",
77
"scripts": {
88
"package": "node scripts/package-extension.mjs",
99
"test": "node --test tests/*.test.mjs"

0 commit comments

Comments
 (0)