~darklands/sreader

78860461b752c935241acea8f245580a3389c5ea — Ben O'Neill 1 year, 2 months ago 09efdb4
add stuff to readme
1 files changed, 30 insertions(+), 1 deletions(-)

M README.md
M README.md => README.md +30 -1
@@ 1,1 1,30 @@
# RSS Reader in Go
# sreader: A Simple TUI Atom and RSS Feed Reader

This uses hex-encoded SHA1 hashes of the desired feeds' URLs to store them. It's
much better than putting the URL or feed name as a filename because that would
look ugly in the filesystem and possibly cause issues.

## Features

- [X] Simple, clean TUI interface
- [X] Open in browser or media player
- [X] Vim keys
- [X] XDG Base Directory Specification compliant
- [ ] Show when an entry has been read
- [ ] View all entries at once
- [ ] Filter out read entries
- [ ] Regex search through entries
- [ ] "Nickname" feeds
- [ ] Config file for keybindings and default browsers/players
- [ ] Search for feeds
- [ ] Color theming
- [ ] Add feeds through the TUI

## Bugs

Submit an issue. Email me a patch or submit a PR if you've fixed it. Emailing
patches is always preferred.

## License

GNU GPL v3 only.