]> git.r.bdr.sh - rbdr/junction/blobdiff - README.md
Add packaging info
[rbdr/junction] / README.md
index 9e420d34a0c58b5aead57236bd383063dbac894d..44f490ddbc3ac4ed5c8cbd22e5b606718d8ba296 100644 (file)
--- a/README.md
+++ b/README.md
@@ -4,6 +4,12 @@ Connect people through any URL
 
 ## Extension
 
 
 ## Extension
 
+First, make sure to build the plugin. From the extension's root you can call:
+
+```
+$ pnpm install && pnpm build
+```
+
 ### Testing on Firefox
 
 In order to test on firefox, first go to `about:debugging`, then click
 ### Testing on Firefox
 
 In order to test on firefox, first go to `about:debugging`, then click
@@ -11,3 +17,14 @@ on the `This Firefox` option. Then click on `Load Temporary Add-On` and
 point the browser to the `extension/manifest.json` file.
 
 This will enable the extension and will allow you to use the inspector to debug.
 point the browser to the `extension/manifest.json` file.
 
 This will enable the extension and will allow you to use the inspector to debug.
+
+### Testing on Chrome
+
+In order to test on chrome, first go to `chrome://extensions/`. Make sure
+`Developer mode` is enabled. Then click `Load Unpacked` and point the browser
+to the `extension` directory.
+
+### Packaging
+
+The makefile includes scripts to create a distributable package. `make package`
+should generate all supported files in the `build/` directory.