Skip to content

Commit c19ff4b

Browse files
committed
Update README
* Update copyright * Remove quick start section * Update installation intructions
1 parent e03f734 commit c19ff4b

File tree

1 file changed

+17
-34
lines changed

1 file changed

+17
-34
lines changed

README.md

Lines changed: 17 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,39 @@
11
# crumble
22

3-
*A highly customizable breadcrumb service for AngularJS with ngRoute. Gets you back home the way __you__ want.*
3+
*A highly customizable breadcrumb service for AngularJS 1.x with ngRoute. Gets you back home the way __you__ want.*
44

5-
While other breadcrumb services for ngRoute make many assumptions about your application, crumble provides sensible defaults but also provides you with the means to customize every detail of the service.
5+
crumble allows you to generate dynamic breadcrumbs for your application.
6+
It provides sensible defaults but also allows you to [customize](#customization) every detail of the service to match your app's structure.
67

78

8-
## Quick start
9+
## Setup
910

10-
Install crumble using [Bower]. Have [ngRoute] up and running.
11-
~~~
12-
bower install angular-crumble --save
13-
~~~
14-
crumble can also be used with [npm] and [Browserify]. It follows the conventions described in this [npm blog post].
11+
### Using a Module System
1512

16-
Add breadcrumb labels. With [interpolation][$interpolate].
17-
~~~js
18-
$routeProvider.when('/', {
19-
label: 'Hello {{name}}!',
20-
// controller, template, ...
21-
})
13+
Install crumble using your favourite package manager
2214
~~~
23-
24-
Generate the breadcrumbs for the current path using the given context for interpolation.
25-
~~~js
26-
crumble.update({
27-
name: 'crumble'
28-
});
15+
yarn add angular-crumble || npm i -S angular-crumble
2916
~~~
3017

31-
Output the breadcrumbs.
32-
~~~html
33-
<a ng-repeat="bc in crumble.trail" ng-href="#{{bc.path}}">
34-
{{bc.label}}
35-
</a>
18+
Require `crumble` in your AngularJS module's dependencies
19+
~~~js
20+
angular.module('app', [require('angular-crumble')]);
3621
~~~
3722

38-
Also check out how you can **[customize crumble](#customization)** to make it fit your needs.
39-
23+
crumble follows the conventions described in this [npm blog post].
4024

41-
## Setup
25+
### Using Plain Old Script Tags
26+
Have [ngRoute] up and running.
4227

43-
Install crumble using [Bower]. Have [ngRoute] up and running.
28+
Download crumble using [Bower] or just manually.
4429
~~~
4530
bower install angular-crumble --save
4631
~~~
4732

48-
Include `crumble.js` in your HTML if you don't use [wiredep] or something similar.
33+
Load `crumble.js` from your HTML.
4934

5035
~~~html
51-
<script src="bower_components/angular-crumble/crumble.js"></script>
36+
<script src="path/to/crumble.js"></script>
5237
~~~
5338

5439
Require `crumble` in your AngularJS module's dependencies
@@ -188,14 +173,12 @@ This repository uses the [Node.js Style Guide][nsg]. Contributions have to follo
188173

189174
## License
190175

191-
Copyright (c) 2014 Raphael von der Grün. Licensed under the MIT License.
176+
Copyright (c) 2014–2017 Raphael von der Grün. Licensed under the MIT License.
192177

193178

194179
[Bower]: http://bower.io/
195-
[wiredep]: https://github.com/taptapship/wiredep
196180
[ngRoute]: https://docs.angularjs.org/api/ngRoute
197181
[$interpolate]: https://docs.angularjs.org/api/ng/service/$interpolate
198182
[nsg]: https://github.com/felixge/node-style-guide
199183
[npm]: https://www.npmjs.com/
200-
[Browserify]: http://browserify.org/
201184
[npm blog post]: http://blog.npmjs.org/post/114584444410

0 commit comments

Comments
 (0)