Skip to content

Commit

Permalink
added README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ClemensLey committed Oct 25, 2018
1 parent 2d98d04 commit 0af4e81
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 1 deletion.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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>)
```
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 0af4e81

Please sign in to comment.