| 1 | KeyLib
|
| 2 | =======
|
| 3 |
|
| 4 | [](https://www.npmjs.org/package/@owstack/key-lib)
|
| 5 | [](https://travis-ci.org/owstack/key-lib)
|
| 6 | [](https://coveralls.io/r/owstack/key-lib)
|
| 7 |
|
| 8 | A JavaScript cryptocurrency key library.
|
| 9 |
|
| 10 | ## Get Started
|
| 11 |
|
| 12 | ```
|
| 13 | npm install @owstack/key-lib
|
| 14 | ```
|
| 15 |
|
| 16 | ## Documentation
|
| 17 |
|
| 18 | The complete docs are hosted here: [keyLib documentation](docs/index.md).
|
| 19 |
|
| 20 | ## Examples
|
| 21 |
|
| 22 | * [Generate a random key](https://github.com/owstack/key-lib/blob/master/docs/examples.md#generate-a-random-address)
|
| 23 | * [Generate a key from a SHA256 hash](https://github.com/owstack/key-lib/blob/master/docs/examples.md#generate-a-address-from-a-sha256-hash)
|
| 24 | * [Import an address via WIF](https://github.com/owstack/key-lib/blob/master/docs/examples.md#import-an-address-via-wif)
|
| 25 |
|
| 26 | ## Security
|
| 27 |
|
| 28 | If you find a security issue, please email security@openwalletstack.com.
|
| 29 |
|
| 30 | ## Contributing
|
| 31 |
|
| 32 | Please send pull requests for bug fixes, code optimization, and ideas for improvement. For more information on how to contribute, please refer to our [CONTRIBUTING](https://github.com/owstack/key-lib/blob/master/CONTRIBUTING.md) file.
|
| 33 |
|
| 34 | ## Building the Browser Bundle
|
| 35 |
|
| 36 | To build a key-lib full bundle for the browser:
|
| 37 |
|
| 38 | ```sh
|
| 39 | gulp browser
|
| 40 | ```
|
| 41 |
|
| 42 | This will generate files named `key-lib.js` and `key-lib.min.js`.
|
| 43 |
|
| 44 | ## Development & Tests
|
| 45 |
|
| 46 | ```sh
|
| 47 | git clone https://github.com/owstack/key-lib
|
| 48 | cd key-lib
|
| 49 | npm install
|
| 50 | ```
|
| 51 |
|
| 52 | Run all the tests:
|
| 53 |
|
| 54 | ```sh
|
| 55 | gulp test
|
| 56 | ```
|
| 57 |
|
| 58 | You can also run just the Node.js tests with `gulp test:node`, just the browser tests with `gulp test:browser`
|
| 59 | or create a test coverage report (you can open `coverage/lcov-report/index.html` to visualize it) with `gulp coverage`.
|
| 60 |
|
| 61 | ## License
|
| 62 |
|
| 63 | Code released under [the MIT license](https://github.com/owstack/key-lib/blob/master/LICENSE).
|
| 64 |
|
| 65 | Copyright 2018 Open Wallet Stack.
|