update readme and docs
This commit is contained in:
parent
24374a266d
commit
6c8d8bef83
2 changed files with 55 additions and 41 deletions
|
|
@ -3,51 +3,54 @@
|
|||
|
||||
I have ambitious plans for the future, there are many features
|
||||
|
||||
## Building a great RSS Desktop Client
|
||||
|
||||
|
||||
## Phase 1: Minimum Viable Platform
|
||||
|
||||
|
||||
### Building a great RSS Desktop Client
|
||||
|
||||
At minimum I need to build a functionally complete RSS reader which will include:
|
||||
- Feed management
|
||||
- Beautiful UI (gonna be hard!)
|
||||
- Multimedia support
|
||||
- Export stories to Markdown
|
||||
|
||||
### Performance
|
||||
- Needs to make use of threads with UI feedback on processing (need to use tasks & `iced::stack`)
|
||||
- Loads of caching
|
||||
- Respect 304 (not modified)
|
||||
|
||||
## Pro-Decentralization
|
||||
|
||||
### Import/Export
|
||||
- Many import/export options (OPML + full database)
|
||||
- Import items from FreshRSS (stories)
|
||||
-
|
||||
### Discovery Service
|
||||
[Phase 1 issues](https://code.gabe.rocks/gabriel/rss-tool/milestone/1)
|
||||
|
||||
RSSCAR will crawl links from the content to discover new feeds. This adds a crucial discovery feature that can help people actually browse the independent web without worrying about censorship.
|
||||
***Once this phase is complete I will begin preparing releases.***
|
||||
|
||||
|
||||
### Darknet Support
|
||||
Censorship resistance matters! Tor & I2P sites should be first-class citizens and handled accordingly.
|
||||
Censorship resistance matters!
|
||||
Tor & I2P sites should be first-class citizens and handled accordingly. This is [currently supported](https://code.gabe.rocks/gabriel/rss-tool/commit/240cb19589bc9d42fbae4331562e0f24413c108c) via the system daemons, but in the future will use mechanisms like [arti-client](https://crates.io/crates/arti-client)
|
||||
|
||||
|
||||
### Information Management
|
||||
|
||||
#### Categories
|
||||
Manage feeds and put them in logical groups
|
||||
|
||||
#### Full-text search
|
||||
- requires [triggers](https://youtu.be/eXMA_2dEMO0) to stay up to date...
|
||||
- Can help a great deal with performing as a useful search engine
|
||||
|
||||
### Strong Multi-media support
|
||||
|
||||
## Phase 2: Enhancements & Polish
|
||||
|
||||
[Issues](https://code.gabe.rocks/gabriel/rss-tool/milestone/2)
|
||||
|
||||
### Information Management
|
||||
- Export stories to Markdown/base for knowledge graphs
|
||||
- Archiving
|
||||
- wayback
|
||||
- local archive
|
||||
|
||||
### Podcasting 2.0
|
||||
Where possible the podcast namespace should be supported (transcriptions, chapters, etc)
|
||||
|
||||
### Discovery Service
|
||||
|
||||
## Information Management
|
||||
RSSCAR will use links from the content to discover new feeds. This adds a crucial discovery feature that can help people actually browse the independent web without worrying about censorship.
|
||||
## Phase 3: Dream features
|
||||
|
||||
|
||||
### Full-text search
|
||||
Basically mandatory
|
||||
- requires [triggers](https://youtu.be/eXMA_2dEMO0) to stay up to date...
|
||||
- Can help a great deal with performing as a useful search engine
|
||||
|
||||
|
||||
### Categories
|
||||
Manage feeds and put them in logical groups
|
||||
|
||||
## Auto archive?
|
||||
- Add stories to wayback machine
|
||||
|
||||
### Markdown Export
|
||||
Export stories for Logseq/Obsidian (how will you get keywords/tags?)
|
||||
[Issues](https://code.gabe.rocks/gabriel/rss-tool/milestone/3)
|
||||
27
readme.md
27
readme.md
|
|
@ -1,21 +1,32 @@
|
|||
RSSCAR
|
||||
======
|
||||
### *RSS Crawler-Aided Reader*
|
||||
|
||||
RSSCAR is a new kind of RSS reader. [RSS is fantastic](https://gabe.rocks/tech/rss-love) but a huge problem is that it lacks *discovery*. With relatively simple client-side crawling, it is trivial to find additional publications related to your own interests.
|
||||
RSSCAR is to be a new kind of RSS reader. [RSS is fantastic](https://gabe.rocks/tech/rss-love) but a reader with *discovery* and darknet support could be a real boon for the independent web. With relatively simple client-side crawling, it is trivial to find additional publications related to your own interests.
|
||||
|
||||
In short: **RSSCAR is to be the RSS reader built for the modern independent web!**
|
||||
|
||||
### Posts:
|
||||
- [Trying out iced](https://gabe.rocks/tech/trying-out-iced/)
|
||||
- [Help me build the best desktop RSS client!](https://gabe.rocks/tech/rss-help)
|
||||
|
||||
This project began as my own way to learn [Rust](https://www.rust-lang.org/) & [iced](https://iced.rs) by building a great RSS desktop client.
|
||||
This project began as my own way to learn [Rust](https://www.rust-lang.org/) & [iced](https://iced.rs) by building a great desktop RSS client.
|
||||
|
||||
This Project is FAR from complete ⏳
|
||||
---
|
||||
*Please be patient!*
|
||||
It's got a long way to go, but progress is ongoing.
|
||||
It's got a long way to go, but progress is ongoing.
|
||||
|
||||
#### Your feedback can make a BIG difference
|
||||
|
||||
Feel free to take a look at the [planned features](docs/planned-features.md) and browse the [issues](https://code.gabe.rocks/gabriel/rss-tool/issues) I'm working on.
|
||||
|
||||
Tips greatly appreciated, currently accepting via monero `83H6o3oMRYog28CbFfG1bQ5vdVG9MQ3itSF1HAPygTyrPsQ7zsXwPXcB5WBei3RqDpdHjitWTeZWkQJSXK3VF8VRG4e2e9R` and [Liberapay](https://liberapay.com/gabe)
|
||||
|
||||
### Posts:
|
||||
|
||||
[RSS feed](https://gabe.rocks/tech/index.xml)
|
||||
|
||||
|
||||
Currently The best way to stay up to date on this would be to follow my [tech only feed](https://gabe.rocks/tech/index.xml)
|
||||
- [Trying out iced](https://gabe.rocks/tech/trying-out-iced/)
|
||||
- [Help me build the best desktop RSS client!](https://gabe.rocks/tech/rss-help)
|
||||
|
||||
---
|
||||
|
||||
This project is heavily inspired by [AntennaPod](https://antennapod.org) which makes great use of multimedia as well as discovery features.
|
||||
|
|
|
|||
Loading…
Reference in a new issue