Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
92nqb committed Aug 18, 2016
1 parent e60a118 commit 78cbad4
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@ language: node_js
node_js:
- "stable"
- "5.0"
- "4.4.3"
- "4.0.0"
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@

[![Build Status](https://travis-ci.org/nquicenob/bresenham-line.svg?branch=master)](https://travis-ci.org/nquicenob/bresenham-line)

**bresenham-line** algorithm for node and Browserify.

## Warning

You need to have support for [ES6 generators](https://developer.mozilla.org/es/docs/Web/JavaScript/Referencia/Sentencias/function*)

## Installation
You can install bresenham-line using npm.

Expand All @@ -17,7 +23,7 @@ Just require the module.

```javascript
// es5
var line = require('bresenham-line').line;
var line = require('bresenham-line');

var genLine = line({
x: 1,
Expand All @@ -35,7 +41,7 @@ console.dir(genLine.next().value); // { x: 3, y: 1 }

```javascript
// es6
import { line } from 'bresenham-line';
import line from 'bresenham-line';

const startPoint = {
x: 1,
Expand Down

0 comments on commit 78cbad4

Please sign in to comment.