Refactor content script

[rbdr/junction] / README.md

diff --git a/README.md b/README.md
index 18d572bca06fa66552f009c7e6ec5f4ef3257140..44f490ddbc3ac4ed5c8cbd22e5b606718d8ba296 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
 # Junction
 
-Connect people through any URL
\ No newline at end of file
+Connect people through any URL
+
+## 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
+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.
+
+### 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.