Skip to content

Update readme #39

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
braydonf wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update readme #39

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
<img src="http://bitcore.io/css/images/module-ecies.png" alt="bitcore ecies" height="35">
# 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)
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

Expand Down