Skip to content

Update README with install instructions and consistent structure #80

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
JohnMcLear merged 3 commits into from
Apr 15, 2026
Merged

Update README with install instructions and consistent structure #80

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
47501c3
Retrigger CI after ueberdb2 fix
JohnMcLear Apr 14, 2026
96dd341
Retrigger CI — etherpad-lite develop has ueberdb2 5.0.43
JohnMcLear Apr 14, 2026
4ae5266
Rewrite README with consistent structure and install instructions
JohnMcLear Apr 14, 2026
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
29 changes: 23 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,27 @@
# ep_rss

![Publish Status](https://github.com/ether/ep_rss/workflows/Node.js%20Package/badge.svg) [![Backend Tests Status](https://github.com/ether/ep_rss/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/ether/ep_rss/actions/workflows/test-and-release.yml)

# Description
Creates an RSS feed and prefixes it to the end of a pad IE as atom.xml IE http://bacon.com/p/yummi/feed
Exposes an RSS feed for each pad at `/p/{padId}/feed`.

## Install

```
pnpm run plugins i ep_rss
```

## Settings

Optional stale time (milliseconds before a new RSS item is generated) can be set in `settings.json`:

```json
"rss": {
"staleTime": 300000
}
```

Defaults to 5 minutes if not configured.

# Installation
Just install then click the Share and Embed button to get the RSS feed URL
## License

# TODO
Smarter creation of new items upon modification
Apache-2.0
Loading