0.16.9 • Published 6 years ago

@gohelpfund/helpcore-lib v0.16.9

Weekly downloads
1
License
MIT
Repository
github
Last release
6 years ago

Helpcore Library

Build Status NPM Package

A pure and powerful JavaScript Help library.

Help is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Help network allows for highly resilient Help infrastructure, and the developer community needs reliable, open-source tools to implement Help apps and services.

Table of Contents

Install

NodeJS

npm install @gohelpfund/helpcore-lib

Browser

See the section below to generate your own bundle, or download the pre-generated minified file

Building the Browser Bundle

To build a helpcore-lib full bundle for the browser:

npm run build

This will generate files named helpcore-lib.js and helpcore-lib.min.js in the dist/ folder.

Usage

Browser

<script src='./dist/helpcore-lib.min.js' type="text/javascript"></script>
<script>
  const PrivateKey = helpcore.PrivateKey;
  const privateKey = new PrivateKey();
  const address = privateKey.toAddress().toString();
</script>

Modules

Some functionality is implemented as a module that can be installed separately:

Development & Tests

git clone https://github.com/gohelpfund/helpcore-lib
cd helpcore-lib
npm install

Run all the tests:

npm test

You can also run just the Node.js tests with npm run test:node, just the browser tests with npm run test:browser or run a test coverage report with npm run coverage.

Documentation

Examples

Some examples can be found here, below is a list of direct links for some of them.

Contributing

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 file.

License

Code released under the MIT license.

Copyright 2013-2017 BitPay, Inc. Bitcore is a trademark maintained by BitPay, Inc.
Copyright 2016-2017 The Dash Foundation, Inc. Copyright 2017-2018 Dash Core Group, Inc.