README.md

# github-slugid

[![NPM version](https://badge.fury.io/js/github-slugid.svg)](http://badge.fury.io/js/github-slugid)
[![Linux Build Status](https://travis-ci.org/SamyPesse/github-slugid.png?branch=master)](https://travis-ci.org/SamyPesse/github-slugid)

Slugify IDs like GitHub.

### Installation

```
npm install github-slugid
```

### Usage

```js
var slug = require('github-slugid');

slug('Hello World') == 'hello-world';
```

[Examples on GitHub](https://gist.github.com/SamyPesse/b3594cc813f026b3fd42)
[Reference](https://github.com/jch/html-pipeline/blob/master/lib/html/pipeline/toc_filter.rb)