From 5a117add1c0a64c4f0141ef0897361774a849246 Mon Sep 17 00:00:00 2001
From: Andinus <andinus@nand.sh>
Date: Thu, 19 Nov 2020 11:42:42 +0530
Subject: Add notes to README & manual regarding new changes

---
 README.org | 23 +++++++++++++++++++++--
 draco.1    | 12 ++++++++++++
 2 files changed, 33 insertions(+), 2 deletions(-)

diff --git a/README.org b/README.org
index e67f818..81f9c93 100644
--- a/README.org
+++ b/README.org
@@ -15,12 +15,31 @@ the reddit API.
 *Tested on*:
 - OpenBSD 6.8 (Perl v5.30.3)
 
+* Why?
+I reference things from the web in my Journal & don't want those links
+to break so I save them locally. Previously I used to manually archive
+the whole thread, this automates it.
 * Installation
 #+BEGIN_SRC sh
 # Clone the project.
 git clone https://git.tilde.institute/andinus/draco && \
     cd draco
 
-# Install.
-sudo make install
+# Install dependencies. (OpenBSD)
+doas pkg_add p5-Text-Wrapper p5-JSON-MaybeXS
+cpan install HTTP::Tiny
+
+# Install. (Use sudo if doas is not present)
+doas make install
 #+END_SRC
+
+* Dependencies
+** Text::Wrapper
+This is used to wrap the text at 72 characters. Draco can work without
+this module.
+** JSON::MaybeXS
+This module is required for Draco to work, it can be replaced with any
+other module that parses JSON & produces same data structure.
+** HTTP::Tiny
+Draco can work without this module if you can get the file some other
+way.
diff --git a/draco.1 b/draco.1
index 013b789..69efabc 100644
--- a/draco.1
+++ b/draco.1
@@ -15,5 +15,17 @@ is a script to convert reddit thread to Org document. It accepts a url
 It'll also print comments along with their replies. It's limited by
 the reddit API.
 .Pp
+.Sh NOTES
+Draco will add a space before every new line. Comments/Posts may
+contain `*' at the start of line & that confuses Org. Org might
+interpret it as a new heading so we add a space before every new line.
+
+All text will be wrapped at 72 characters.
+.Pp
+.Sh WHY?
+I reference things from the web in my Journal & don't want those links
+to break so I save them locally. Previously I used to manually archive
+the whole thread, this automates it.
+.Pp
 .Sh AUTHOR
 .An Andinus Aq Mt andinus@nand.sh
-- 
cgit 1.4.1-2-gfad0