Skip to content

Commit ec50e09

Browse files
committed
update README.md and add npm scripts for package run and build
1 parent 34c0f69 commit ec50e09

File tree

3 files changed

+45
-21
lines changed

3 files changed

+45
-21
lines changed

.jpmignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,6 @@
1515

1616
# Existing packages
1717
*.xpi
18+
19+
# dev dependencies packages
20+
/node_modules/jpm/

README.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,41 @@
1-
FireAngular 0.1
2-
===============
1+
FireAngular 0.0.1-zeta.1
2+
========================
33

44
Firefox plugin for Angular development. Built on top of native
5-
developer tools in Firefox. [Firebug 3] isn't required, but the
6-
screen-shot below shows how native developer tools look like
7-
when Firebug theme is activated.
5+
developer tools in Firefox and based on the [firebug.sdk](firebug.sdk).
86

9-
![](https://raw.githubusercontent.com/rpl/fireangular/master/docs/images/inspector.png)
7+
[Firebug 3](firebug.next) isn't required, but the screen-shot below shows how native developer tools
8+
look like when Firebug theme is activated.
109

11-
![](https://raw.githubusercontent.com/rpl/fireangular/master/docs/images/inspector_firebug.png)
10+
![](https://raw.githubusercontent.com/firebug/fireangular/master/docs/images/inspector.png)
11+
12+
![](https://raw.githubusercontent.com/firebug/fireangular/master/docs/images/inspector_firebug.png)
1213

1314
Try it for yourself:
1415

1516
1. Install [FireAngular](https://github.com/rpl/fireangular/releases) (currently zeta)
1617
2. Load an Angular webapp, e.g. [TODO MVC Angular](http://todomvc.com/examples/angularjs/#/)
1718
3. Inspect an Angular generated DOM Element
1819

20+
Build it by yourself:
21+
22+
1. Clone the repository: ```git clone https://github.com/firebug/fireangular.git```
23+
2. Install npm dependencies ```npm install```
24+
3. Run ```npm run jpm-run [-- -b /path/to/firefox]```
25+
4. or Build xpi ```npm run jpm-xpi```
26+
1927
License
2028
-------
2129
FireAngular is free and open source software distributed under the
2230
[BSD License](https://github.com/rpl/fireangular/blob/master/license.txt).
2331

2432
Hacking on FireAngular
2533
--------------------
26-
See FireAngular [Developer Guide](https://github.com/rpl/fireangular/wiki/Developer-Guide)
34+
See FireAngular [Developer Guide](https://github.com/firebug/fireangular/wiki/Developer-Guide)
2735

2836
Further Resources
2937
-----------------
3038
* DevTools Extension Examples: https://github.com/mozilla/addon-sdk/tree/devtools/examples
39+
40+
[firebug.sdk]: https://github.com/firebug/firebug.sdk
41+
[firebug.next]: https://github.com/firebug/firebug.next

package.json

Lines changed: 23 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,17 +28,27 @@
2828
"url": "https://github.com/firebug/fireangular/issues"
2929
},
3030
"preferences-branch": "firebug.fireangular",
31-
"preferences": [{
32-
"name": "AngularURL",
33-
"title": "AngularURL",
34-
"description": "",
35-
"type": "string",
36-
"value": "chrome://fireangular-resources/content/angular.js"
37-
}, {
38-
"name": "AngularURLTimeout",
39-
"title": "AngularURLTimeout",
40-
"description": "",
41-
"type": "integer",
42-
"value": 5000
43-
}]
31+
"preferences": [
32+
{
33+
"name": "AngularURL",
34+
"title": "AngularURL",
35+
"description": "",
36+
"type": "string",
37+
"value": "chrome://fireangular-resources/content/angular.js"
38+
},
39+
{
40+
"name": "AngularURLTimeout",
41+
"title": "AngularURLTimeout",
42+
"description": "",
43+
"type": "integer",
44+
"value": 5000
45+
}
46+
],
47+
"devDependencies": {
48+
"jpm": "^1.0.0"
49+
},
50+
"scripts": {
51+
"jpm-run": "jpm run ",
52+
"jpm-xpi": "jpm xpi "
53+
}
4454
}

0 commit comments

Comments
 (0)