From 0af4e819b268bddb3a5278f80ff039c6a0a49471 Mon Sep 17 00:00:00 2001
From: Clemens Ley <ley.clemens@gmail.com>
Date: Thu, 25 Oct 2018 11:55:18 -0700
Subject: [PATCH] added README.md

---
 README.md    | 25 +++++++++++++++++++++++++
 package.json |  2 +-
 2 files changed, 26 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index c34429e..e9911e3 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,26 @@
 # Bitcoin Token
+
+BitcoinToken is a toolkit for building blockchain enabled applications on top of Bitcoin Cash. It consists of three tools: a wallet, a database built on the blockchain, and a token solution. These are meant to be combined by the developer to adapt to the desired application. BitcoinToken is written in Javascript and runs in the browser and in node.
+
+## Install
+
+To install BitcoinToken run
+
+```
+npm i bitcointoken
+```
+
+To test the library, you also need to install and run a [Bitcoin non-standard server](https://github.com/the-bitcoin-token/bitcoin-non-standard-server).
+
+You can find more information and developer documentation at <a href="http://www.bitcointoken.com">www.bitcointoken.com</a> and <a href="http://www.bitcointoken.com/docs">www.bitcointoken.com/docs</a>.
+
+## Example usage
+
+You can issue a token in Javascript. You can find more examples in the <a href="http://www.bitcointoken.com/docs">BitcoinToken docs</a>
+
+```
+const token = new BitcoinToken()
+await token.create({ data: { balance: '10' }})
+await token.getBalance() 
+await token.send(1, <public key>)
+```
\ No newline at end of file
diff --git a/package.json b/package.json
index 7f3b9b1..641b0da 100644
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "bitcointoken",
   "license": "UNLICENSED",
-  "version": "0.0.1-alpha.2",
+  "version": "0.0.1-alpha.3",
   "description": "Build smart contract powered apps",
   "main": "index.js",
   "repository": {