diff options
author | Andinus <andinus@nand.sh> | 2020-08-29 23:42:26 +0530 |
---|---|---|
committer | Andinus <andinus@nand.sh> | 2020-08-29 23:42:26 +0530 |
commit | 4fb6c9cae4e358d2ca2ad2874d569cd637ea9b0e (patch) | |
tree | 99281094aba04a81c1c46bebaa94348fa8eb845f | |
parent | b9778e3478c3ccf8ab27710ee996d1e853a40555 (diff) | |
download | pyxis-4fb6c9cae4e358d2ca2ad2874d569cd637ea9b0e.tar.gz |
Document commands in README
-rw-r--r-- | README | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/README b/README index 0bb88c1..eae7758 100644 --- a/README +++ b/README @@ -5,6 +5,14 @@ ━━━━━━━━━ +Table of Contents +───────────────── + +1 Documentation +.. 1.1 Configuration +.. 1.2 Commands + + Pyxis is a simple twtxt client. [twtxt] is a decentralised, minimalist microblogging service for @@ -58,3 +66,20 @@ hackers. Add your feeds to `%feeds' hash like shown above. You can remove those 2 `use' lines but it's good if you keep them. + + +1.2 Commands +──────────── + +1.2.1 fetch +╌╌╌╌╌╌╌╌╌╌╌ + + fetch will fetch all the latest feeds. + + +1.2.2 timeline +╌╌╌╌╌╌╌╌╌╌╌╌╌╌ + + timeline will print your timeline from all the feeds. You can also + pass an optional argument to load a single feed. For example, `pyxis + timeline user' will load the feed `user'. |