From a3bda6d98c384ded8e59ca91afcffe501c5b8320 Mon Sep 17 00:00:00 2001 From: Sibi Prabakaran Date: Sun, 19 Mar 2017 11:55:10 +0530 Subject: [PATCH] Update README with usage info --- README.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 64e0c8b..d92a1e6 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,30 @@ Haskell client for tldr -![tldr](https://cloud.githubusercontent.com/assets/737477/24076451/2a5a604c-0c57-11e7-9bf7-13d76e8e7f12.png) - ## Installation 1. [Install stack](https://docs.haskellstack.org/en/stable/README/#how-to-install) 2. Clone this repo (TODO: Publish this to Stackage) 3. `stack install` + +## Usage + +``` shellsession +$ tldr --help +tldr - Simplified and community-driven man pages + +Usage: tldr [-v|--version] [--update] COMMAND + tldr Client program + +Available options: + -h,--help Show this help text + -v,--version Show version + --update Update tldr pages + COMMAND name of the command +``` + +## Snapshot + +![tldr](https://cloud.githubusercontent.com/assets/737477/24076451/2a5a604c-0c57-11e7-9bf7-13d76e8e7f12.png) + +