angular-slugifier/README.md

AngularJS bindings for the wonderful speakingurl library

# angular-slugifier

AngularJS bindings for the wonderful [SpeakingURL](https://github.com/pid/speakingurl) library

## How do I add this to my project?

You can download `angular-slugifier` by:

* Using bower and running `bower install angular-slugifier`
* Using npm and running `npm install angular-slugifier`
* Downloading it manually from this repo

## How to use angular-slugifier

This module exposes a `$speakingurl` service that can be used in the code,
and a `angular-slugifier` filter that can be used in templates directly:

```
MyAngularModule = (function () {
  var myModule = angular.module('my.module', ['angular-slugifier']);

  myModule.controller('MyController', function ($scope, $speakingurl, model) {
    $scope.model   = model;
    $scope urlSlug = $speakingurl.slugify(model.name, {});
  });
```

```
<ul>
  <li ng-repeat="user in users">
    <a href="/user/{{ user.fullName | slugify }}" ng-bind="user.fullName"></a>
  </li>
</ul>