Skip to content

Commit

Permalink
Updating README and adding repository to package.json
Browse files Browse the repository at this point in the history
  • Loading branch information
tomtaylor committed Nov 29, 2010
1 parent 859d036 commit 8760280
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Expand Up @@ -112,12 +112,19 @@ stdin and writing to stdout.

### Building and installation

This module depends on node-v0.1.97 or higher.
There are two ways to install msgpack.

Installation is a manual process: use `make` to build the add-on, then manually
copy `build/default/mpBindings.node` and `lib/msgpack.js` it to wherever your
NodeJS installation will look for it (or add the build directory to your
`$NODE_PATH`).
## npm

npm install msgpack

This should build and install msgpack for you. Then just `require('msgpack')`.

## Manually

Use `make` to build the add-on, then manually copy `build/default/mpBindings.node`
and `lib/msgpack.js` it to wherever your node.js installation will look for it (or
add the build directory to your `$NODE_PATH`).

% ls
LICENSE Makefile README.md deps/ src/ tags test.js
Expand Down
4 changes: 4 additions & 0 deletions package.json
Expand Up @@ -7,6 +7,10 @@
"contributors": [
"Tom Taylor <tom@tomtaylor.co.uk> (http://tomtaylor.co.uk)"
],
"repository": {
"type": "git",
"url": "https://github.com/pgriess/node-msgpack.git"
},
"main": "./lib/msgpack",
"directories": {
"lib": "lib"
Expand Down

0 comments on commit 8760280

Please sign in to comment.