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 82edda0 commit efff5d2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 7 deletions.
17 changes: 12 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,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-bandsintown-api-factory`
2. `npm install --save angular-bandsintown-api-factory`
3. download [angular-bandsintown-api-factory.zip](https://github.com/JohnnyTheTank/angular-bandsintown-api-factory/zipball/master)
2. Add `jtt_bandsintown` 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-bandsintown-api-factory/src/angular-bandsintown-api-factory.js"></script>
<script src="bower_components/angular-bandsintown-api-factory/src/angular-bandsintown-api-factory.min.js"></script>
```
2. When using npm:
```html
<script src="node_modules/angular-bandsintown-api-factory/src/angular-bandsintown-api-factory.min.js"></script>
```
3. when using downloaded files
```html
<script src="angular-bandsintown-api-factory.min.js"></script>
```

4. Use the factory `bandsintownFactory`


Expand Down
4 changes: 3 additions & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "angular-bandsintown-api-factory",
"description": "angularjs factory for bandsintown json rest api requests",
"description": "angularjs promise library for bandsintown json rest api requests",
"version": "0.5.0",
"main": "Gruntfile.js",
"authors": [
Expand All @@ -11,6 +11,8 @@
"angularjs",
"angular",
"bandsintown",
"events",
"music",
"api",
"factory"
],
Expand Down
4 changes: 3 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "angular-bandsintown-api-factory",
"version": "0.5.0",
"description": "angularjs factory for bandsintown json rest api requests",
"main": "Gruntfile.js",
"main": "dist/angular-bandsintown-api-factory.min.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
Expand All @@ -14,6 +14,8 @@
"angularjs",
"angular",
"bandsintown",
"events",
"music",
"api",
"factory"
],
Expand Down

0 comments on commit efff5d2

Please sign in to comment.