docs(readme): describe how to run and use the proxy in dev environment

Add description on how to get a local proxy running for development purposes. Including on how to run it in a K8s cluster using DevSpace.

Fixes #18

Author: Addono

README.md

@@ -17,8 +17,8 @@
 - [About](#about)
 - [Getting Started](#getting_started)
 - [Running the Tests](#tests)
-- [Deployment](#deployment)
 - [Usage](#usage)
+- [Deployment](#deployment)
 - [Contributors](#contributors)
 
 ## 🧐 About <a name = "about"></a>
@@ -41,7 +41,9 @@ First we need to install all dependencies, run:
 yarn install
 ```
 
-To start the development environment, run:
+### Running Locally
+
+To start the development environment using either of the following commands:
 
 ```bash
 # Without file watching
@@ -51,27 +53,60 @@ yarn start
 yarn dev
 ```
 
-## 🔧 Running the Tests <a name = "tests"></a>
+### Running in Kubernetes using DevSpace
 
-After setting up the development environment, tests can be invoked using:
+Build the application, the `--watch` flag is optional and enables automatic hotreloading:
 
 ```bash
-yarn test
+yarn build --watch
+```
+
+Then to configure and launch [DevSpace](https://devspace.sh/) run:
+
+```bash
+# Configure DevSpace to the desired namespace
+devspace use namespace container-registry-provider
+
+# Deploy a development version onto K8s
+devspace dev
 ```
 
 ## 🎈 Usage <a name="usage"></a>
 
-Execute:
+Once you have a proxy running, you can use it like this:
 
 ```bash
-yarn build
+# For https://hub.docker.com/r/addono/container-registry-proxy
+docker pull localhost:8080/addono/container-registry-proxy
+
+# For https://hub.docker.com/_/nginx
+docker pull localhost:8080/library/nginx
 ```
 
-Which builds the app for production to the `dist` folder.
+> Note: If your Docker daemon is running in a VM, which would be the case if you're using Docker Toolbox on Mac, then pulling directly from localhost will not work. One workaround is using ngrok to have a publicly available domain name to connect to:
+>
+> ```bash
+> # Note the ngrok domain assigned to you
+> ngrok http 8080
+>
+> # Make sure to replace the ngrok domain name
+> docker pull 5d354ae8.ngrok.io/library/nginx
+> ```
+
+## 🔧 Running the Tests <a name = "tests"></a>
+
+After setting up the development environment, tests can be invoked using:
+
+```bash
+yarn test
+```
 
 ## 🚀 Deployment <a name = "deployment"></a>
 
-We automatically build and deploy the latest version to NPM.
+We automatically build and deploy the latest version and all [releases](https://github.com/Addono/container-registry-proxy/releases) to:
+
+- [NPM](https://www.npmjs.com/package/container-registry-proxy)
+- [Docker Hub](https://hub.docker.com/r/addono/container-registry-proxy)
 
 ## ✨ Contributors <a name = "contributors"></a>