greuler/README.md

graph theory visualizations powered by d3 & webcola

<p align="center">
  <a href="http://mauriciopoppe.github.io/greuler/">
    <img src="./public/src/banner.svg" alt="greuler logo">
  </a>
</p>

<p align="center">
  <a href="https://npmjs.org/package/greuler">
    <img src="https://img.shields.io/npm/v/greuler.svg?style=flat" alt="NPM">
  </a>
  <a href="https://github.com/mauriciopoppe/greuler/workflows/CI">
    <img src="https://github.com/mauriciopoppe/greuler/workflows/CI/badge.svg" />
  </a>
  <a href="https://github.com/feross/standard">
    <img src="https://img.shields.io/badge/code%20style-standard-blue" alt="js-standard-style">
  </a>
</p>

---

<b>greuler</b> is graph theory visualization tool powered by <a href="http://d3js.org/">d3</a>
and on top of <a href="http://marvl.infotech.monash.edu/webcola/">WebCola</a>
which allows the creation and manipulation of graphs with a simple API.

## Installation

```sh
npm install greuler@alpha
```

or

```html
<script src="https://unpkg.com/greuler@alpha"></script>
```

## Usage

```js
import greuler from 'greuler'
greuler({
  // options in the homepage
})
```

## Examples

Check out the examples at the [`homepage`](http://mauriciopoppe.github.io/greuler/)

## License

2021 MIT © Mauricio Poppe

[npm-image]: https://img.shields.io/npm/v/greuler.svg?style=flat
[npm-url]: https://npmjs.org/package/greuler