Skip to content

Commit

Permalink
Merge pull request #406 from tynes/readme-install-instructions
Browse files Browse the repository at this point in the history
readme: update install instructions
  • Loading branch information
boymanjor authored Mar 30, 2020
2 parents ed53f5f + 158099b commit aae18c8
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ __HSD__ is an implementation of the [Handshake][handshake] Protocol.

`hsd` requires Node.js v10 or higher


### Building From Source

```
$ git clone git://github.com/handshake-org/hsd.git
$ cd hsd
Expand All @@ -20,6 +23,36 @@ Note that `node-gyp` must be installed. See the
[node-gyp](https://github.com/nodejs/node-gyp) documentation for more
information.

### npm

It is not recommended to install `hsd` from npm's repositories
but it is still possible to install with `npm` using a remote
`git` repository.

```
$ npm install -g https://github.com/handshake-org/hsd.git
```

A `git` ref can be used to install a particular version by appending
a `#` and the name of the `git` ref to the URL. For example,
`https://github.com/handshake-org/hsd.git#v2.1.3`. It is recommended
to use the [latest tagged release](https://github.com/handshake-org/hsd/releases).

If adding `hsd` as a dependency to a project, use the command:

```
$ npm install https://github.com/handshake-org/hsd.git
```

### macOS

`hsd` is available via [Homebrew](https://brew.sh). This will
install all required dependencies as well as `unbound`.

```
$ brew install hsd
```

## CLI

HSD comes with command-line interface tools `hsd-cli` (to interact with the node
Expand Down

0 comments on commit aae18c8

Please sign in to comment.