Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dy committed Jul 25, 2017
1 parent 2f1fe00 commit 3bf8d0e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
@@ -1,6 +1,6 @@
# colormap [![Build Status](https://travis-ci.org/bpostlethwaite/colormap.png)](https://travis-ci.org/bpostlethwaite/colormap)

![all colormap output](./example/colormaps.png)
![all colormap output](./colormaps.png)

## Usage

Expand Down Expand Up @@ -35,7 +35,7 @@ where leaving `options = {}` or `undefined` results in the defaults given above.
The `colormap` option can be any of the supported builtin colormaps. Or you can add your own. For an example of how to add your own see the json format available at:

```javascript
colorscales = require('colormap/colorScales')
colorscales = require('colormap/colormap')
```

Colorscales are a sequence of objects containing an `index` and `rgb` key. The index defines how fast or slow the `rgb` values will change from one segment to the next. Ie.the steepness of the gradient between two segments. The `rgb` parameter can hold a length 3 or 4 array, depending if alpha values are included in the mapping.
Expand Down

0 comments on commit 3bf8d0e

Please sign in to comment.