From 59ac2e81e38a1c0788de0e4b0d51c832dc8ba927 Mon Sep 17 00:00:00 2001 From: Gregory Scheerlinck Date: Tue, 2 Feb 2016 13:58:40 +0000 Subject: [PATCH] updated readme --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 181f47e..40ce12f 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,18 @@ -_This is a work in progress_ - A tool to browse and search a constantly updated local copy of the entire (English) Arch Wiki on the command line using `man`. # Installation ``` -npm install arch-wiki-man +npm install -g arch-wiki-man +``` + +# Updating +``` +npm install -g arch-wiki-man + ``` +Updates are pushed automatically every two days to `https://github.com/greg-js/arch-wiki-md-repo`, a dependency for this project. Whenever the install command is run, the changes will be fetched. -# Usage +# Usage & Examples Use the `awman` command (it stands for arch wiki man)