X-Git-Url: https://git.r.bdr.sh/rbdr/junction/blobdiff_plain/02bc8bc5e3d040d2aee4c611a2bed59f6ac90f35..5685e249653cae8c2ba97c0c59c45e3221d8ffa2:/README.md?ds=inline diff --git a/README.md b/README.md index 18d572b..44f490d 100644 --- 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.