From afffbbcb2a034bd1cad83b31f442cf77f17c2151 Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Sun, 30 Aug 2020 02:07:21 +0530
Subject: Add installation instructions in README, version option in help

---
 README | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)

(limited to 'README')

diff --git a/README b/README
index f1905f7..d7c8c01 100644
--- a/README
+++ b/README
@@ -14,6 +14,8 @@ Table of Contents
 .. 2.1 Commands
 .. 2.2 Examples
 .. 2.3 Configuration
+3 Installation
+.. 3.1 Dependencies
 
 
 Pyxis is a simple twtxt client.
@@ -115,3 +117,22 @@ 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.
+
+
+3 Installation
+══════════════
+
+  Install these dependencies from CPAN. Then just clone the repository,
+  copy the config & run pyxis!
+
+
+3.1 Dependencies
+────────────────
+
+  • Getopt::Long is required only for options.
+  • [HTTP::Tiny] is only required if you use `fetch'.
+  • Path::Tiny can be replaced with perl core.
+  • Term::ANSIColor is just for good looks.
+  • Time::Moment can be replaced with DateTime or you can just `sort' it
+    directly. Sorting directly will mess up the order a bit but should
+    be okay for most cases.
-- 
cgit 1.4.1-2-gfad0