Skip to content

Commit

Permalink
Update README with install info
Browse files Browse the repository at this point in the history
  • Loading branch information
cpettitt committed Aug 28, 2013
1 parent 7531fec commit 95a83e9
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,33 @@ maintain backwards compatibility, for patch level increases (e.g. 0.0.1 to
0.0.2) but make no claim to backwards compatibility across minor releases (e.g.
0.0.1 to 0.1.0). Watch our [CHANGELOG](CHANGELOG.md) for details on changes.

# Build / Install
# Getting Graphlib

Before building this library you need to install the [npm package manager].
## NPM Install

Before installing this library you need to install the [npm package manager].

To get graphlib from npm, use:

$ npm install graphlib

## Browser Scripts

You can get the latest browser-ready scripts:

* [graphlib.js](http://cpettitt.github.io/project/graphlib/latest/graphlib.js)
* [graphlib.min.js](http://cpettitt.github.io/project/graphlib/latest/graphlib.min.js)

## Build From Source

Before building this library you need to install the [npm package manager].

Check out this project and run this command from the root of the project:

$ make

This will generate `graphlib.js` and `graphlib.min.js` in the root of the project.

# Example

```js
Expand Down

0 comments on commit 95a83e9

Please sign in to comment.