Create new npm scripts, update Readme

Closes #47
This commit is contained in:
casebenton 2016-08-05 10:31:00 -07:00
Родитель df23549ca4
Коммит 66de68b39a
2 изменённых файлов: 11 добавлений и 6 удалений

Просмотреть файл

@ -1,18 +1,22 @@
# Add-on Recommendation
Stand-alone add-on for use in Shield studies.
# To build
# To build an XPI
```bash
$ npm run build
$ jpm xpi
```
This will create `@addon-recommendation-0.0.1.xpi`, which you can install in Firefox.
This will create `@addon-recommendation-0.0.*.xpi`, which you can install in Firefox.
Alternatively, use jpm run to have jpm start a new instance of Firefox with add-on loaded:
```bash
$ npm run styles
$ jpm run
```
# To use
With the add-on installed, navigate to any of the domains listed in
in `data/recommendation/localData.json`. Currently recommendations are provided
on Reddit, Wikipedia, and SoundCloud.
in `data/recommendation/localData.json`.
# License
This add-on is licensed under the MPLv2. See the `LICENSE` file for details.

Просмотреть файл

@ -14,7 +14,8 @@
"jetpack"
],
"scripts": {
"build": "node-sass data/recommendation/style.scss data/recommendation/style.css --sourcemap=none && jpm xpi",
"styles": "node-sass data/recommendation/style.scss data/recommendation/style.css --sourcemap=none",
"build": "npm run styles && jpm xpi",
"lint": "eslint lib data"
},
"devDependencies": {