aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndinus <andinus@nand.sh>2020-08-30 01:37:00 +0530
committerAndinus <andinus@nand.sh>2020-08-30 01:37:00 +0530
commit686ee30ccdd05e8afa8b25af66bb17d9401dd39f (patch)
tree7353bd848bf040e2ef2cdfa28d8e14239e1a48da
parent324010fb3d7158ab6845212699df6d0a87c074b6 (diff)
downloadpyxis-686ee30ccdd05e8afa8b25af66bb17d9401dd39f.tar.gz
Add screenshots to README
-rw-r--r--README40
1 files changed, 28 insertions, 12 deletions
diff --git a/README b/README
index ad60dfa..d0ae415 100644
--- a/README
+++ b/README
@@ -8,10 +8,12 @@
Table of Contents
─────────────────
-1 Documentation
-.. 1.1 Commands
-.. 1.2 Examples
-.. 1.3 Configuration
+1 Demo
+.. 1.1 Screenshots
+2 Documentation
+.. 2.1 Commands
+.. 2.2 Examples
+.. 2.3 Configuration
Pyxis is a simple twtxt client.
@@ -27,7 +29,17 @@ hackers.
[twtxt] https://github.com/buckket/twtxt
-1 Documentation
+1 Demo
+══════
+
+1.1 Screenshots
+───────────────
+
+ • timeline [2020-08-30 Sun]
+ [https://andinus.nand.sh/static/pyxis/2020-08-30_timeline.png]
+
+
+2 Documentation
═══════════════
The feeds are saved in `$XDG_DATA_HOME/pyxis', if it's not defined
@@ -35,10 +47,10 @@ hackers.
`$XDG_CONFIG_HOME/pyxis.pl' or `$HOME/.config/pyxis.pl'.
-1.1 Commands
+2.1 Commands
────────────
-1.1.1 fetch
+2.1.1 fetch
╌╌╌╌╌╌╌╌╌╌╌
fetch will fetch all the latest feeds from config file. You can use
@@ -46,7 +58,7 @@ hackers.
data directory.
-1.1.2 timeline
+2.1.2 timeline
╌╌╌╌╌╌╌╌╌╌╌╌╌╌
timeline will print your timeline from all the feeds. You can also
@@ -57,7 +69,7 @@ hackers.
prints a warning & goes to the next one.
-1.2 Examples
+2.2 Examples
────────────
┌────
@@ -70,11 +82,15 @@ hackers.
└────
-1.3 Configuration
+2.3 Configuration
─────────────────
- There is an example config file under `share/config.pl', move it
- config directory & rename it to `pyxis.pl'.
+ There is an example config file under `share/config.pl', move it to
+ config directory & rename to `pyxis.pl'.
+
+ ┌────
+ │ cp share/config.pl $HOME/.config/pyxis.pl
+ └────
*Warning*: Pyxis will evaluate the configuration file, which means an
attacker can use it to run malicious code.