Skip to content

docs: guide first feed setup #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KitsuneSemCalda merged 1 commit into from
Oct 4, 2026
Merged

docs: guide first feed setup #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 23 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,23 +32,16 @@ cd Feader-RSS
The installer validates the manifest, builds the backend in a staging
directory, and copies the required files to
`~/.config/omarchy/plugins/io.github.kitsunesemcalda.feader-rss/`, then enables
the widget in the right bar section. It preserves your feed configuration and
creates a timestamped backup of the configuration, UI preferences, and SQLite
article database, then keeps the active article cache so read/unread state
persists across updates. If the shell does not detect the copy immediately, run
`omarchy restart shell`.

Backups are stored separately in
`~/.local/state/omarchy/rss-reader/backups/`. To create one manually, run
`./scripts/backup.sh`.
Each backup contains `rss-reader.json`, `preferences.json`, and an `items.db`
snapshot when those files exist. The SQLite snapshot uses SQLite's online
backup API, so committed data in the WAL is included and no `-wal`/`-shm`
sidecars need to be copied. Older backups containing only `items.json` remain
accepted for compatibility.
To restore a backup, run `./scripts/restore.sh /path/to/backup`; the current
data is backed up first, and an `items.db` snapshot replaces the active
database even when it already contains articles.
the widget in the right bar section. If the shell does not detect the copy
immediately, run `omarchy restart shell`.

Click the Feader icon in the bar, open **Configure feeds**, and add an RSS or
Atom URL. Refresh the reader to see the feed's articles; selecting one opens
its cached text. The plugin needs network access to fetch configured feeds.

The installer preserves your existing feed configuration and reading state and
creates a timestamped backup before updating them. See [Backups and restore](#backups-and-restore)
for recovery commands.

## Distribution through the Omarchy plugin system

Expand Down Expand Up @@ -172,6 +165,19 @@ configured-feed database, not only the first `maxItems` visible rows. Feed
refreshes retry transient network/5xx failures with exponential backoff, while
failed article prefetches are remembered and delayed for up to six hours.

## Backups and restore

Backups are stored in `~/.local/state/omarchy/rss-reader/backups/`. To create
one manually, run `./scripts/backup.sh`. Each backup contains
`rss-reader.json`, `preferences.json`, and an `items.db` snapshot when those
files exist. The SQLite snapshot uses SQLite's online backup API, so committed
data in the WAL is included. Older backups containing only `items.json` remain
accepted for compatibility.

To restore a backup, run `./scripts/restore.sh /path/to/backup`. The current
data is backed up first; an `items.db` snapshot replaces the active database
even when it already contains articles.

## Theme and notifications

The panel uses Omarchy's live `Color` and `Style` tokens, so surfaces, focus
Expand Down
Loading