Skip to content

Commit

Permalink
fix: steps to setup, explore and test installation
Browse files Browse the repository at this point in the history
  • Loading branch information
p3k committed Nov 12, 2015
1 parent e91e293 commit ef6d105
Showing 1 changed file with 33 additions and 5 deletions.
38 changes: 33 additions & 5 deletions README.md
Expand Up @@ -6,20 +6,48 @@ _Graphyte_ is a JavaScript based graph visualization library built with emphasis

```bash
npm install graphyte
cd graphyte
npm install
```

## General Usage

_Graphyte_ is following the AMD module pattern using [RequireJS](http://requirejs.org):

```javascript
require.config({
baseUrl: 'node_modules/graphyte',
paths: {
'd3': 'node_modules/d3/d3'
}
});

require(['d3', 'js/core'], function(d3, graphyte) {
var graph = graphyte()
.width(800)
.height(600)
.debug(true);
});
```

## Examples

To run the examples in your browser:

```bash
cd graphyte
npm install --only=dev
cd node_modules/graphyte
npm install
npm start
```

## Testing

_Graphyte_ is using QUnit for testing its basic functionality:

```bash
cde node_modules/graphyte
npm install
npm test
```

## Documentation

See Wiki: https://github.com/weblyzard/graphyte/wiki
See Wiki: <https://github.com/weblyzard/graphyte/wiki>

0 comments on commit ef6d105

Please sign in to comment.