From 079f1441b0a786b5d4a9a1c00a2b3311068c54e6 Mon Sep 17 00:00:00 2001 From: rooki <34943569+Pdzly@users.noreply.github.com> Date: Mon, 20 May 2024 21:25:07 +0200 Subject: [PATCH] Update setup instructions in README.md and add new scripts in package.json The README.md file was updated to provide detailed instructions for installing dependencies, local development, build process and linting for Firefox and Chrome. Also, the scripts section in package.json was enhanced with commands for building, running, signing, and linting for both Firefox and Chrome. --- README.md | 41 +++++++++++++++--- .../web-ext-artifacts/startyparty-3.4.1.zip | Bin 63865 -> 63865 bytes package.json | 8 +++- 3 files changed, 42 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a7583ba..d538fe2 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,52 @@ -### zip +### installing dependencies ```bash -zip -r startyparty.zip * +npm install ``` -### testing +### local development + +#### firefox ```bash -web-ext run +npm run start:firefox ``` +This will start a new firefox instance with the addon installed and reload the addon on file changes. + +#### Chrome + +You have to load the "chrome" folder as an unpacked extension in chrome. + ### build +#### Firefox + ```bash -web-ext build +npm run build:firefox ``` +#### Chrome + +```bash +npm run build:chrome +``` + +### Linting + +#### Firefox + +```bash +npm run lint:firefox +``` + +#### Chrome -- It will lint it as a firefox addon so it will show some errors + +```bash +npm run lint:chrome +``` + + ### firefox addon [https://addons.mozilla.org/en-US/firefox/addon/startyparty/](https://addons.mozilla.org/en-US/firefox/addon/startyparty/) diff --git a/chrome/web-ext-artifacts/startyparty-3.4.1.zip b/chrome/web-ext-artifacts/startyparty-3.4.1.zip index 40e49654273643048d8e4ce5dd64edb7616324a1..ae77f7ee526d5965d8352a4fcec8c4783b05ef20 100644 GIT binary patch delta 338 zcmezQiTURzW}X0VW)?061_lm>=9!!QnZx9nnrCj_ryP2P3n9LdN0JdFtj?$frk5*; zg6PS?OrLldnM4?1`X`_KAtTSgz`&51oS&zwo0wCgSCE$;;Ekfj`lpOkggitI7HRn( zGWFX(L#2z$&~$H!kdHRm%E-vTP|U=@zzebqjxT*-V8~6(%S=lxF44;>&d)=&cuT|) zh1Rnl7#JAVFfuT3!nJ`I|GqLXsXChvf0krqnyRz;-WM$pJz4SlCoY8aMxHQvkSy0X zQIPEB6#39AJd8{t3^4tZC;X6MVqloO?uVG|RGlpm^3f(+85tQEikTP~co~p^G$R8; zZem_$T555LURH5_UVt}>K^8w{WZjt<81hofOA?dxGD>oD&{W9(kYRFWo^1O=nrW)e zWX7K|OtY0H%l{My@uGgnC~Z<^V8~3)&(kZ&OAqj7WdqsH#=yo9#K^!P_yfcP0G5kD Axc~qF diff --git a/package.json b/package.json index b3bb165..b121b8f 100644 --- a/package.json +++ b/package.json @@ -8,8 +8,12 @@ }, "scripts": { "test": "echo \"Error: no test specified\" && exit 1", - "build:firefox": "web-ext build --source-dir firefox", - "run:firefox": "web-ext run --source-dir firefox" + "build:firefox": "web-ext build --source-dir firefox --overwrite-dest --ignore-files \"*.zip\" --artifacts-dir firefox/web-ext-artifacts", + "run:firefox": "web-ext run --source-dir firefox --overwrite-dest --ignore-files \"*.zip\" --artifacts-dir firefox/web-ext-artifacts", + "sign:firefox": "web-ext sign --source-dir firefox --overwrite-dest --ignore-files \"*.zip\" --artifacts-dir firefox/web-ext-artifacts", + "lint:firefox": "web-ext lint --source-dir firefox --ignore-files \"*.zip\"", + "build:chrome": "web-ext build --source-dir chrome --overwrite-dest --ignore-files \"*.zip\" --artifacts-dir chrome/web-ext-artifacts", + "lint:chrome": "web-ext lint --source-dir chrome --ignore-files \"*.zip\"" }, "author": "", "license": "ISC" -- 2.51.2