diff --git a/web/ecashjs-lib/CHANGELOG.md b/web/ecashjs-lib/CHANGELOG.md index 47d728e0e..347b5d4aa 100644 --- a/web/ecashjs-lib/CHANGELOG.md +++ b/web/ecashjs-lib/CHANGELOG.md @@ -1,13 +1,19 @@ # 1.0.0 **renamed** - Package from bitcoincashjs-lib to ecashjs-lib # 1.0.1 **replaced** - `@psf/bitcoincash-ops` with `ecash-ops` - `@psf/pushdata-bitcoin` with `pushdata-ecash` - `@psf/minimaldata` with `ecash-minimaldata` + +# 1.0.2 + +**added** + +- Updated README.md diff --git a/web/ecashjs-lib/README.md b/web/ecashjs-lib/README.md index 4ed805da9..2a32fec6a 100644 --- a/web/ecashjs-lib/README.md +++ b/web/ecashjs-lib/README.md @@ -1,3 +1,20 @@ -# BitcoinCashJS (bitcoincashjs-lib) +# ecashjs-lib -Fork of the amazing [bitcoinjs-lib](https://github.com/bitcoinjs/bitcoinjs-lib). +A javascript eCash library for node.js and browsers. + +## Usage + +`npm i ecashjs-lib` + +`import eCash from 'ecashjs-lib'; // ReactJS` +`const eCash = require('ecashjs-lib'); // NodeJS` + +### Examples + +`ecashjs-lib` is used in production at Cashtab.com. + +- [Create an eCash wallet](https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/web/cashtab/src/hooks/useWallet.js) + +- [Encode OP_RETURN messages](https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/web/cashtab/src/utils/cashMethods.js) + +- [Build eCash transactions](https://github.com/Bitcoin-ABC/bitcoin-abc/blob/master/web/cashtab/src/utils/txBuilder.js) diff --git a/web/ecashjs-lib/package.json b/web/ecashjs-lib/package.json index 0a3650111..c89f6d958 100644 --- a/web/ecashjs-lib/package.json +++ b/web/ecashjs-lib/package.json @@ -1,64 +1,64 @@ { "name": "ecashjs-lib", - "version": "1.0.1", + "version": "1.0.2", "description": "Client-side eCash JavaScript library", "main": "./src/index.js", "engines": { "node": ">=10.15.1" }, "keywords": [ "ecashjs", "ecash", "xec", "bitcoinjs", "bitcoin", "browserify", "javascript" ], "scripts": { "coverage-report": "nyc report --reporter=lcov", "coverage-html": "nyc report --reporter=html", "coverage": "nyc --check-coverage --branches 90 --functions 90 mocha", "integration": "mocha test/integration/", "test": "mocha" }, "repository": { "type": "git", "url": "https://github.com/Bitcoin-ABC/bitcoin-abc.git" }, "files": [ "src" ], "dependencies": { "bech32": "^1.1.2", "bigi": "^1.4.0", "bip66": "^1.1.0", "bs58check": "^2.0.0", "create-hash": "^1.1.0", "create-hmac": "^1.1.3", "ecash-ops": "^1.0.1", "ecurve": "^1.0.0", "merkle-lib": "^2.0.10", "pushdata-ecash": "^1.0.0", "randombytes": "^2.0.1", "safe-buffer": "^5.0.1", "typeforce": "^1.18.0", "varuint-bitcoin": "^1.0.4", "wif": "^2.0.1" }, "devDependencies": { "async": "^2.0.1", "bip39": "^2.3.0", "bs58": "^4.0.0", "cb-http-client": "^0.2.0", "chai": "^4.2.0", "coinselect": "^3.1.1", "dhttp": "^2.3.5", "ecash-minimaldata": "^1.0.2", "mocha": "^6.1.4", "nyc": "^14.1.1", "proxyquire": "^1.8.0", "sinon": "^1.17.7" }, "license": "MIT" }