Skip to content
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

README.md with improved formatting and fixes #15

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README.md with improved formatting and fixes #15

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0b9278d
README.md with improved formatting and fixes
Jun 12, 2023
e9edae7
Small fix
Jun 12, 2023
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
30 changes: 15 additions & 15 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,16 @@
TermFeed
====
# TermFeed

[![PyPI version](https://badge.fury.io/py/termfeed.svg)](http://badge.fury.io/py/termfeed)

**Term**inal **Feed** is a *minimal* feed **reader** for the terminal (without curses).

To read, preview, open, store, or delete your favorite RSS feeds from the command line.
TermFeed is a minimal RSS reader for your terminal. You can read, preview, open, store, and delete your favorite RSS feeds directly from the command line.

#### Why?
## Why TermFeed?
TermFeed is perfect for terminal addicts who want to stay up-to-date with the world by quickly reading feed summaries WITHOUT leaving the terminal.

If 1) you are a terminal addict, and 2) you want to stay up to date with the outside world by reading quick feed and summaries WITHOUT having to leave your terminal; then TermFeed is for you. These are the main reasons I created TermFeed.



### Usage
## Usage

`$ feed`

Expand Down Expand Up @@ -56,15 +53,15 @@ If 1) you are a terminal addict, and 2) you want to stay up to date with the out
- rebuild the library from `urls.py`


### Features (what you can do?)
## Features (what you can do?)

- List feeds from different sources (stored in your library) with colorful text.
- Preview a short summary of a selected feed.
- Jump to (optionally) the source page of a feed in default browser.
- Store new (or delete) RSS URLs in (from) your library under a specific topic or under the default tag `General`.


### Examples
## Examples

<!-- see: TermFeed gifs repo: http://imgur.com/a/EBHho
-->
Expand Down Expand Up @@ -117,7 +114,7 @@ Options:
```


### Installation
## Installation

1) from `PyPI` repository:

Expand All @@ -131,7 +128,7 @@ download and unpack the [zipped folder](https://github.com/iamaziz/TermFeed/arch
$ cd TermFeed
$ python setup.py install

### Uninstall
## Uninstall


$ pip uninstall TermFeed
Expand All @@ -144,20 +141,23 @@ This file is created at the home directory (e.g. `$HOME/.termfeed.db`), delete i
> `$ sudo ...`


#### Dependencies
### Dependencies

- [feedparser](https://pypi.python.org/pypi/feedparser)


#### Miscellaneous
### Miscellaneous

- Tested on OS X and Linux.
- Supports Python 2.7 and Python 3.4
- The URLs in `urls.py` are complementary. They will be added to your library at `$HOME/.termfeed.db` when you run TermFeed (`$ feed`) for the first time. You may delete them all and have your own list instead.
- [Instant RSS Search](http://ctrlq.org/rss) is a nice search engine for searching RSS feeds.


### Author
## Creator

- Aziz Alto

## Contributors
- Bradley
- Victor van Liederen