From 74a6ec5fe5d1d10c465c231e64c7b964476464f3 Mon Sep 17 00:00:00 2001
From: Marcin Chrzanowski <marcin.j.chrzanowski@gmail.com>
Date: Sun, 16 Jul 2017 00:15:06 -0400
Subject: Implement CLI

---
 README.md | 23 ++++++++++++++++++++++-
 1 file changed, 22 insertions(+), 1 deletion(-)

(limited to 'README.md')

diff --git a/README.md b/README.md
index e2474b3..711a25c 100644
--- a/README.md
+++ b/README.md
@@ -4,9 +4,30 @@ A dice expression parser and roller.
 
 ## Installation
 
+    # in a local node_modules/
     npm install --save dicebag
+    # globally, to use the CLI
+    npm install -g dicebag
 
-## Usage
+## Command-line usage
+
+    dicebag [-p] [<dice expression>]
+
+If a dice expression is provided, prints the result of rolling those dice and
+exits. Otherwise, reads expressions from `stdin` in a loop.
+
+* `-p` print dice pools (default behavior is to print the dice's sum)
+
+### Examples
+
+    $ dicebag 1d6
+    1
+    $ dicebag "2d8 + 1d4"
+    7
+    $ dicebag -p "2d8 + 1d4"
+    [ 5, 3, 4 ]
+
+## Library usage
 
     const { parse, pool, roll } = require('dicebag')
 
-- 
cgit v1.2.3