From 594ec0323ce9e64383d31b5017497c28404ff9cc Mon Sep 17 00:00:00 2001 From: Braydon Fuller Date: Fri, 23 Oct 2015 12:37:28 -0400 Subject: [PATCH] Update readme --- README.md | 13 +++++++++++-- docs/index.md | 2 ++ 2 files changed, 13 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d56e402..176323f 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -bitcore ecies -# ECIES for bitcore +# ECIES for Bitcore [![NPM Package](https://img.shields.io/npm/v/bitcore-ecies.svg?style=flat-square)](https://www.npmjs.org/package/bitcore-ecies) [![Build Status](https://img.shields.io/travis/bitpay/bitcore-ecies.svg?branch=master&style=flat-square)](https://travis-ci.org/bitpay/bitcore-ecies) @@ -13,6 +12,16 @@ Credit to [@ryanxcharles][ryan] for the original implementation. ## Getting started +```sh +npm install bitcore-lib +npm install bitcore-ecies +``` + +```sh +bower install bitcore-lib +bower install bitcore-ecies +``` + ECIES will allow to securely encrypt and decrypt messages using ECDSA key pairs (bitcoin cryptography). ```javascript diff --git a/docs/index.md b/docs/index.md index 2bf47c2..f87fb81 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,12 +9,14 @@ ECIES is implemented as a separate module and you must add it to your dependenci For node projects: ```bash +npm install bitcore-lib --save npm install bitcore-ecies --save ``` For client-side projects: ```bash +bower install bitcore-lib --save bower install bitcore-ecies --save ```