Skip to content
Merged
Changes from all commits
Commits
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
15 changes: 7 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,20 @@ Point any RSS reader (NetNewsWire, Feedly, Miniflux, etc.) at the `/feed` endpoi
### Pull Beehiiv articles into a mobile app

```tsx
// React Native — works with any RSS parsing library
// React Native — example with rss-parser (https://www.npmjs.com/package/rss-parser)
import Parser from 'rss-parser';

const parser = new Parser();
const response = await fetch('https://your-server.com/feed?url=https://newsletter.beehiiv.com');
const feed = await parse(await response.text());
const feed = await parser.parseString(await response.text());
// feed.title, feed.items[0].title, feed.items[0].content, etc.
```

Same approach works for web apps, desktop apps, static site generators, or any HTTP-capable client.

### Save feeds as static files via cron

```cron
*/15 * * * * curl -fsS "http://localhost:8000/feed?url=https://newsletter.beehiiv.com" > /var/www/feeds/newsletter.xml
```

Serve the XML files directly from a web server — no Python process needed at read time.
Schedule periodic `curl` requests to `/feed` and write the XML to disk (see [Using cron](#using-cron) under Self-hosting). Serve the files directly from a web server — no Python process needed at read time.

### Embed newsletter content in your own website

Expand Down Expand Up @@ -160,7 +159,7 @@ Errors return JSON:

## Known limitations

- Only `*.beehiiv.com` subdomains are supported. Custom domains are not yet detectable unless they use standard Beehiiv markup.
- Only `*.beehiiv.com` subdomains are supported. Custom domains are not supported.
- Article discovery relies on the homepage HTML. If Beehiiv changes its page structure, discovery may break.
- Pages rendered entirely by JavaScript are not supported.
- Articles without a clear title are skipped.
Expand Down
Loading