Rename upload to publish

[rbdr/junction] / README.md

diff --git a/README.md b/README.md
index 18d572bca06fa66552f009c7e6ec5f4ef3257140..25f9d9813db7b26a33d77769bad8d9cd3e98124b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,46 @@
 # Junction
 
 # Junction
 

-Connect people through any URL
\ No newline at end of file
+Connect people through any URL
+
+## Server
+
+### Environment variables
+
+* `JUNCTION_PORT`: This sets the port in which the app will be listening
+
+### Running for development
+
+The project uses docker for easier local development.
+
+1. Create a `.env` file in the root
+2. Run `make run` to start the local dev server
+
+### Building for production
+
+Run `make build`. This will create and tag the image.
+
+### Publishing image
+
+Run `make publish`. This will push the image to docker hub.
+
+## Extension
+
+First, make sure to build the plugin. From the extension's root you can call:
+
+```
+$ yarn install && yarn 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.