aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-08-30 01:10:48 +0530
committerAndinus <andinus@nand.sh>2020-08-30 01:10:48 +0530
commit56b5f9095c6d2fc0c5bffb87836b4d812aa18d29 (patch)
tree175d916a02bbb0ebe36c5542239c3a4109d33996
parent6139a5c6c4adebe129666842eb91a77674c6d03a (diff)
downloadpyxis-56b5f9095c6d2fc0c5bffb87836b4d812aa18d29.tar.gz
Add examples section, simplify documentation
-rw-r--r--README34
1 files changed, 23 insertions, 11 deletions
diff --git a/README b/README
index f1f74e1..c997fcb 100644
--- a/README
+++ b/README
@@ -10,7 +10,8 @@ Table of Contents
1 Documentation
.. 1.1 Commands
-.. 1.2 Configuration
+.. 1.2 Examples
+.. 1.3 Configuration
Pyxis is a simple twtxt client.
@@ -29,9 +30,6 @@ hackers.
1 Documentation
═══════════════
- Pyxis can only follow feeds currently. I'm writing this for fun, more
- features will be added if I use it.
-
The feeds are saved in `$XDG_DATA_HOME/pyxis', if it's not defined
then `$HOME/.local/share/pyxis' is used. Feeds are configured in
`$XDG_CONFIG_HOME/pyxis.pl' or `$HOME/.config/pyxis.pl'.
@@ -43,22 +41,36 @@ hackers.
1.1.1 fetch
╌╌╌╌╌╌╌╌╌╌╌
- fetch will fetch all the latest feeds.
+ fetch will fetch all the latest feeds from config file. You can use
+ Pyxis without this feature by fetching the files yourself manually to
+ data directory.
1.1.2 timeline
╌╌╌╌╌╌╌╌╌╌╌╌╌╌
timeline will print your timeline from all the feeds. You can also
- pass an optional argument to load a single feed.
+ pass an optional argument to load custom feeds.
+
+ For example, you can pass multiple feeds like `pyxis timeline f1 f2',
+ it'll load both `f1' & `f2'. If you pass an invalid feed then it
+ prints a warning & goes to the next one.
+
+
+1.2 Examples
+────────────
- For example, `pyxis timeline user' will load the feed `user'. You can
- pass multiple feeds like `pyxis timeline f1 f2', it'll load both `f1'
- & `f2'. If you pass an invalid feed then it prints a warning & goes to
- the next one.
+ ┌────
+ │ pyxis fetch # fetch all feeds
+ │
+ │ # dispay emacs & perl feeds (if available)
+ │ pyxis timeline emacs perl
+ │
+ │ pyxis timeline # display all feeds
+ └────
-1.2 Configuration
+1.3 Configuration
─────────────────
There is an example config file under `share/config.pl', move it