bcalc

commit c06c18c50fe46bf07ad7d25f32892f6b7e3eab8b
parent 74282472f6fe1ae53971d364c2dfac82d8b2695b
Author: William Casarin <jb55@jb55.com>
Date:   Sat, 16 Dec 2017 23:09:21 -0800

readme: updates

Diffstat:
M
README.md
 | 
29
++++++++++++++++++++++++++---

1 file changed, 26 insertions(+), 3 deletions(-)
diff --git a/README.md b/README.md
@@ -3,9 +3,27 @@
 
   A simple calculator that understands Bitcoin Units
 
-## Usage
+## Examples
 
-    $ bcalc <<<'1 msat + 2 sats + 3 bits'
+  Basic example
+
+    $ bcalc --msat -p <<<'1 msat + 2 sats + 3 bits'
+    302001 msat
+
+  BTC to satoshis
+
+    $ bcalc -p <<<'0.02 BTC'
+    2000000 sat
+
+  satoshis to millisatoshis (for payment channels)
+
+    $ bcalc --msat <<<'100 sat'
+    100000
+
+  mBTC + bits to BTC
+
+    $ bcalc -p --btc <<<'100 mBTC + 20 bits'
+    0.10002 BTC
 
 ## Install
 
@@ -13,4 +31,9 @@
 
 ## Units
 
-
+  - BTC,
+  - mBTC (milli-bitcoin),
+  - bits (μBTC, micro-bitcoin),
+  - finney,
+  - satoshi (sat),
+  - millisatoshi (msat),