Skip to content

Commit a85bea5

Browse files
committed
README: add Node LTS version hint, and warning about npm
1 parent b8a5192 commit a85bea5

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,29 @@ Master is not stable; it is our development branch, and [only tagged releases ma
1818
1919
We recommend every user of this library and the [bitcoinjs](https://github.com/bitcoinjs) ecosystem to audit and verify any underlying code for its validity and suitability.
2020

21-
Mistakes and bugs happen, but with your help in resolving and reporting [issues](https://github.com/bitcoinjs/bitcoinjs-lib/issues), together we can produce open source software library that is:
21+
Mistakes and bugs happen, but with your help in resolving and reporting [issues](https://github.com/bitcoinjs/bitcoinjs-lib/issues), together we can produce open source software that is:
2222

2323
- Easy to audit and verify,
24-
- Tested, with test coverage >90%,
24+
- Tested, with test coverage >95%,
2525
- Advanced and feature rich,
2626
- Standardized, using [standard](http://github.com/standard/standard) and Node `Buffer`'s throughout, and
2727
- Friendly, with a strong and helpful community, ready to answer questions.
2828

29-
3029
## Installation
3130
``` bash
3231
npm install bitcoinjs-lib
3332
```
3433

34+
Typically we support the [Node Maintenance LTS version](https://github.com/nodejs/Release).
35+
If in doubt, see the [.travis.yml](.travis.yml) for what versions are used by our continuous integration tests.
36+
37+
**WARNING**: We presently don't provide any tooling to verify that the release on `npm` matches GitHub. As such, you should verify anything downloaded by `npm` against your own verified copy.
38+
39+
3540
## Setup
3641
### Node.js
3742
``` javascript
38-
var bitcoin = require('bitcoinjs-lib')
43+
const bitcoin = require('bitcoinjs-lib')
3944
```
4045

4146
### Browser

0 commit comments

Comments
 (0)