corobel/README.md

25 lines
791 B
Markdown
Raw Normal View History

2022-11-01 01:57:20 +00:00
# Corobel
2022-10-30 17:44:07 +00:00
2022-11-01 01:57:20 +00:00
Translate Cohost projects and posts into RSS 2.0 feeds so you can follow them in your RSS reader.
2022-10-30 17:44:07 +00:00
## What it currently does
2022-11-01 01:57:20 +00:00
Corobel provides feeds at `/<project>/feed.rss` and Webfinger objects at `.well-known/webfinger?<project>`.
2022-10-30 17:44:07 +00:00
2022-11-01 01:57:20 +00:00
Set your domain name with `--domain`. If you must, you can configure the base URL with `--base-url`.
A template SystemD unit file is provided at `config/corobel.service`. See `Rocket.toml` for the appropriate
ports to use for development and deployment.
2022-10-30 17:44:07 +00:00
## Todo
2022-11-01 01:57:20 +00:00
- [x] Webfinger for Cohost projects
- [ ] Handle redirects
2022-11-01 02:21:05 +00:00
- [x] RSS feeds for projects
- [x] Index page explaining what's going on
2022-11-01 01:57:20 +00:00
- [ ] RSS feeds for tags
2022-11-01 02:41:07 +00:00
- [x] Atom Extension pagination support
2022-11-01 01:57:20 +00:00
- [ ] Read More support
- [ ] Dublin Core support
- [ ] Media Envelope support