<commit_before># angular-breadcrumb

Generate a breadcrumb from ui-router's states

## Getting Started
### On the server
_(Coming soon)_

### In the browser
Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/ncuillery/angular-breadcrumb/master/dist/angular-breadcrumb.min.js
[max]: https://raw.github.com/ncuillery/angular-breadcrumb/master/dist/angular-breadcrumb.js

In your web page:

```html
<script src="dist/angular-breadcrumb.min.js"></script>
<script>
awesome(); // "awesome"
</script>
```

In your code, you can attach angular-breadcrumb's methods to any object.

```html
<script>
var exports = Bocoup.utils;
</script>
<script src="dist/angular-breadcrumb.min.js"></script>
<script>
Bocoup.utils.awesome(); // "awesome"
</script>
```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

_Also, please don't edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!_

## Release History
_(Nothing yet)_

## License
Copyright (c) 2013 <NAME>  
Licensed under the MIT license.<commit_msg>Add doc<commit_after># angular-breadcrumb

Generate a breadcrumb from ui-router's states

## In development
angular-breadcrumb is unusable for the moment. Basic functionalities are currently in development.

### Roadmap
- [x] Build a breadcrumb presenting a step for each state in the current state's hierarchy
- [ ] Display a human readeable label for each step in the breadcrumb
- [ ] Build a working link for each step expect the last one.
- [ ] Probably first release here ;-)
- [ ] Reflection about templating (maybe not everybody want to use the [bootstrap's breadcrumb](http://getbootstrap.com/components/#breadcrumbs))

## Getting Started
### Dependencies
angular-breadcrumb requires ui-router in minimal version *0.2.0* (when the method `$state.get` was added).

Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/ncuillery/angular-breadcrumb/master/dist/angular-breadcrumb.min.js
[max]: https://raw.github.com/ncuillery/angular-breadcrumb/master/dist/angular-breadcrumb.js

In your web page:

```html
<script src="dist/angular-breadcrumb.min.js"></script>
```

Add dependency to your app module:
```js
'ncy-angular-breadcrumb'
```

Use the directive `ncy-breadcrumb'
```html
<div ncy-breadcrumb></div>
```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

## License
Copyright (c) 2013 <NAME>  
Licensed under the MIT license.
{'fraction_non_alphanumeric': 0.12227805695142378, 'fraction_numerical': 0.0036850921273031824, 'mean_word_length': 4.820662768031189, 'pattern_counts': {'":': 0, '<': 19, '<?xml version=': 0, '>': 19, 'https://': 4, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3885863', 'n_tokens_mistral': 935, 'n_tokens_neox': 903, 'n_words': 315}