From 6bd50e7dddea75b4b1dc88e44262e99b46e6073e Mon Sep 17 00:00:00 2001 From: Kagami Hiiragi Date: Sat, 13 Dec 2014 21:59:48 +0300 Subject: [PATCH] Add usage stub --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 454a40b..9c3bed0 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,18 @@ JavaScript Bitmessage library for both browserify and node. +## Usage + +You need ES6 Promise available in order to use this module. Use some sort of ES6 runtime or just apply polyfill: + +```js +require("es6-promise").polyfill(); +``` + +```js +var bitmessage = require("bitmessage"); +``` + ## License bitmessage - JavaScript Bitmessage library