Add info on building the .xpi

yuvipanda · Nov 7, 2021 · 0e20189 · 0e20189
1 parent a484f19
commit 0e20189
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -17,4 +17,14 @@ can just copy the nbgitpuller URL, and share it with your students!
 ![nbgitpuller popover](screenshot-popover.png)
 
 The JupyterHub URL and application you choose are remembered, so
-you do not need to enter it over and over again.
+you do not need to enter it over and over again.
+
+## Building the webextension
+
+```bash
+npm install
+npx webpack --mode=production
+npx web-ext build -s dist/
+```
+
+This produces a `.xpi` file in `web-ext-artifacts/` you can use.
diff --git a/package.json b/package.json
@@ -23,6 +23,7 @@
     "@babel/preset-react": "^7.16.0",
     "babel-loader": "^8.2.3",
     "copy-webpack-plugin": "^9.0.1",
+    "web-ext": "^6.5.0",
     "webpack": "^5.62.1",
     "webpack-cli": "^4.9.1"
   },

diff --git a/src/manifest.json b/src/manifest.json
@@ -1,6 +1,6 @@
 {
 	"manifest_version": 2,
-	"name": "nbgitpuller generator",
+	"name": "nbgitpuller Link generator",
 	"version": "1.0",
 	"description": "Generate nbgitpuller links from your browser",
 	"icons": {