Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mourner committed Feb 2, 2018
1 parent 5b901eb commit 7589a5f
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
## dobbyscan
## dobbyscan [![Build Status](https://travis-ci.org/mapbox/dobbyscan.svg?branch=master)](https://travis-ci.org/mapbox/dobbyscan) [![Simply Awesome](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)

[![Build Status](https://travis-ci.org/mapbox/dobbyscan.svg?branch=master)](https://travis-ci.org/mapbox/dobbyscan)
[![Simply Awesome](https://img.shields.io/badge/simply-awesome-brightgreen.svg)](https://github.com/mourner/projects)

A very fast density based clustering JavaScript library for geographic points.
A very fast density based clustering JavaScript library for geographic points. Implements a variation of [DBSCAN](https://en.wikipedia.org/wiki/DBSCAN) with great circle distance metric.

### Example

Expand All @@ -25,3 +22,9 @@ Returns an array of clusters, where each cluster is an array of points (from the
### Performance

This library is incredibly fast — run `bench.js` to see it cluster 140k points in a couple seconds.

### Install

```
npm install dobbyscan
```

0 comments on commit 7589a5f

Please sign in to comment.