From 9740fc47a749fc1850476085d5a885138a5ad14d Mon Sep 17 00:00:00 2001 From: Thomas Rupprecht Date: Thu, 5 Jan 2023 17:14:32 +0100 Subject: [PATCH] improve README --- README.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index a9b48d2..064a15a 100644 --- a/README.md +++ b/README.md @@ -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