Updated the readme and added a manpage and bash completion.HEADmaster

Signed-off-by: David Moc <personal@cdatgoose.org>

1 files changed, 63 insertions, 7 deletions

diff --git a/README.org b/README.org
index 5f074bc..20b1d18 100644
--- a/README.org
+++ b/README.org
@@ -1,16 +1,72 @@
 #+AUTHOR: David Moc
 #+EMAIL: personal@cdatgoose.org
 
-
 * Tasker
-Tasker is a simple task tracker (with built in fish completion) written in Haskell.
+
+Tasker is a simple task tracker written in Haskell.
+
+It includes optional shell completion support for:
+
+- fish
+- bash
 
 * Install
-You can eiter use the `./build.sh` that installs into:
-- `/usr/local/bin/tasker`				
-- `/usr/share/fish/vendor_completions.d/tasker.fish`
-Or just run:
+
+** Installer:
+
+#+begin_src shell
+  ./install.sh
+#+end_src
+
+This builds the executable with Cabal and installs it to:
+
+- =/usr/local/bin/tasker=
+
+The installer also detects your current shell and installs the matching completion file when available.
+
+For fish, it installs:
+
+- =/usr/share/fish/vendor_completions.d/tasker.fish=
+
+For bash, it installs:
+
+- =/usr/share/bash-completion/completions/tasker=
+
+If a manpage is available, it is installed to:
+
+- =/usr/local/share/man/man1/tasker.1=
+
+** Manual:
+
+#+begin_src shell
+  ./install.sh --shell fish
+  ./install.sh --shell bash
+  ./install.sh --shell all
+  ./install.sh --shell none
+#+end_src
+
+To skip installing the manpage:
+
+#+begin_src shell
+  ./install.sh --no-man
+#+end_src
+
+* Build only
+
+To build Tasker without installing it:
+
 #+begin_src shell
   cabal build exe:tasker
 #+end_src
-and copy the file to your bin.
+
+You can locate the built executable with:
+
+#+begin_src shell
+  cabal list-bin exe:tasker
+#+end_src
+
+Then copy it manually to a directory on your =$PATH=, for example:
+
+#+begin_src shell
+  cp "$(cabal list-bin exe:tasker)" ~/.local/bin/tasker
+#+end_src