Skip to content

Commit

Permalink
chore: create npm reference (close #1)
Browse files Browse the repository at this point in the history
  • Loading branch information
JohnnyTheTank committed Jan 6, 2016
1 parent 33b2761 commit e777c78
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,24 @@ Author: Jonathan Hornung ([JohnnyTheTank](https://github.com/JohnnyTheTank))

## Usage

1. Install via [bower](http://bower.io/) :
1. Install via either [bower](http://bower.io/), [npm](https://www.npmjs.com/) or downloaded files:
1. `bower install --save angular-github-api-factory`
2. `npm install --save angular-github-api-factory`
3. download [angular-github-api-factory.zip](https://github.com/JohnnyTheTank/angular-github-api-factory/zipball/master)
2. Add `jtt_github` to your application's module dependencies.
3. Include dependencies in your HTML.
1. When using bower:

```html
<script src="bower_components/angular/angular.js"></script>
<script src="bower_components/angular-github-api-factory/src/angular-github-api-factory.js"></script>
<script src="bower_components/angular-github-api-factory/src/angular-github-api-factory.min.js"></script>
```
2. When using npm:
```html
<script src="node_modules/angular-github-api-factory/src/angular-github-api-factory.min.js"></script>
```
3. when using downloaded files
```html
<script src="angular-github-api-factory.min.js"></script>
```

4. Use the factory `githubFactory`


Expand Down

0 comments on commit e777c78

Please sign in to comment.