improve README

This commit is contained in:
Thomas Rupprecht 2023-01-05 17:14:32 +01:00
parent 86b3b7ef5e
commit 9740fc47a7
1 changed files with 20 additions and 8 deletions

View File

@ -10,20 +10,32 @@
## Install
```ssh
$ git clone https://gitea.usrspace.at/XimeX/usrspace-browser-addon.git
$ npm install -g web-ext
$ npm install
$ npm i -g web-ext
$ npm i
```
- Open `about:debugging` or `about:debugging-new` in Firefox
- Click `Load Temporary Add-on...`
- Navigate to Add-on Repository
- Open `manifest.json`
- Use it
## Run / Develop / Debug
```ssh
$ npm run watch:{firefox|firefox-android|chromium}
```
If more options are needed add them after a `--`.
Some useful options:
- `--devtools`
- `--firefox-apk=...`
- `--android-device=...`
Example: `npm run watch:firefox-android -- --firefox-apk=org.mozilla.fenix --firefox-device=XXXXXXXX`.
## Build
```ssh
$ npm run build
```
## Release
```ssh
$ npm version {major|minor|patch|...}
$ web-ext build
```
## Credits