Skip to content
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

Jump to bottom

pkg: add lockfile #642

Merged
merged 2 commits into from
Nov 30, 2018
Merged

pkg: add lockfile #642

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a916bfa
pkg: add lockfile
braydonf Nov 29, 2018
7b734cd
docs: update installation details and requirements
braydonf Nov 30, 2018
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
31 changes: 17 additions & 14 deletions docs/Beginner's-Guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Bcoin is an _alternative_ implementation of the bitcoin protocol, written in nod
## Requirements

- Linux, OSX, or Windows (\*) (\*\*)
- node.js >=v7.6.0
- npm >=v4.0.0
- node.js >=v8.14.0
- npm >=v6.4.1
- python2 (for node-gyp)
- gcc/g++ (for leveldb and secp256k1)
- git (optional, see below)
Expand All @@ -17,27 +17,30 @@ Bcoin is an _alternative_ implementation of the bitcoin protocol, written in nod

## Build & Install

Bcoin is meant to be installed via npm, but for the security conscious, it may be better to clone from github. All tagged commits for release should be signed by @chjj's [PGP key][keybase] (`B4B1F62DBAC084E333F3A04A8962AB9DE6666BBD`). Signed copies of node.js are available from [nodejs.org][node], or from your respective OS's package repositories.

### Installing via NPM

``` bash
$ npm install -g bcoin --production
```
Bcoin is meant to be installed via git for security purposes, as there are security issues when installing via npm. All tagged commits for release should be signed by @chjj's [PGP key][keybase] (`B4B1F62DBAC084E333F3A04A8962AB9DE6666BBD`). Signed copies of node.js are available from [nodejs.org][node], or from your respective OS's package repositories.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍


### Installing via Git

``` bash
$ curl https://keybase.io/chjj/pgp_keys.asc | gpg --import
$ git clone git://github.com/bcoin-org/bcoin.git
$ cd bcoin
```

For a specific release:
```
$ git tag
...
v1.0.0-alpha # latest version
$ git tag -v v1.0.0-alpha # verify signature
$ git checkout v1.0.0-alpha
$ npm install -g --production
$ git tag -v <version> # verify signature
$ git checkout <version>
```

Install dependencies:
```
$ npm install
$ npm install -g # link globally
```
**Note:** Dependencies are checked for integrity using `package-lock.json`. However `npm` _will not_ make these checks with `npm install -g` and it will link your installation globally so that `bcoin` is in your path _(e.g. $ bcoin)_.

### Installing via Docker

Check [bcoin-docker](https://github.com/bcoin-org/bcoin-docker)
Expand Down