abiosoft · abiosoft · Oct 12, 2021 · Sep 13, 2021 · Sep 14, 2021 · Sep 15, 2021
diff --git a/.github/workflows/go.yml b/.github/workflows/go.yml
@@ -0,0 +1,26 @@
+name: Go
+
+on:
+  push:
+    branches: [ main, golang-rewrite ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Go
+      uses: actions/setup-go@v2
+      with:
+        go-version: 1.17
+
+    - name: Build
+      run: go build -v ./...
+
+    - name: Test
+      run: go test -v ./...
+
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 .idea/
-.vscode/
+.vscode/
+_output/
diff --git a/Makefile b/Makefile
@@ -0,0 +1,13 @@
+all: dev
+
+clean:
+	rm -rf _output
+
+dev:
+	go get -v ./cmd/colima
+
+release:
+	sh release.sh ${VERSION}
+
+gh_release:
+	GITHUB=1 sh release.sh ${VERSION}
diff --git a/README.md b/README.md
@@ -1,14 +1,25 @@
 # Colima
 
-Docker (and Kubernetes) on macOS with minimal setup.
+[![Go](https://github.com/abiosoft/colima/actions/workflows/go.yml/badge.svg)](https://github.com/abiosoft/colima/actions/workflows/go.yml)
+
+Container runtimes on macOS with minimal setup.
 
 ![Demonstration](colima.gif)
 
+## Features
+
+- Simple CLI interface
+- Docker and Containerd support
+- Port Forwarding
+- Volume mounts
+- Kubernetes
+
+
 ## Getting Started
 
 ### Prerequisites
 
-Colima requires [Lima](https://github.com/lima-vm/lima) and Docker client (and kubectl if Kubernetes will be enabled).
+Colima requires [Lima](https://github.com/lima-vm/lima), Docker client (for Docker runtime) and kubectl (if Kubernetes will be enabled).
 
 ```
 brew install lima docker kubectl
@@ -17,19 +28,20 @@ brew install lima docker kubectl
 ### Installation
 
 ```
-curl -LO https://raw.githubusercontent.com/abiosoft/colima/v0.1.10/colima && sudo install colima /usr/local/bin/colima
+curl -LO https://github.com/abiosoft/colima/releases/download/v0.2.0/colima-amd64 && sudo install colima-amd64 /usr/local/bin/colima
 ```
 
 Verify install
 
-```sh
+```
 colima version
 ```
 
-Command line usage
+Command line usages
 
 ```
 colima --help
+colima start --help
 ```
 
 ## Usage
@@ -39,20 +51,30 @@ colima --help
 `colima start` starts and setup Docker by default.
 You can use the `docker` client on macOS after `colima start` with no additional setup.
 
+### Containerd
+
+`colima start --runtime containerd` starts and setup Containerd. You can use `colima nerdctl` to interact with Containerd using [nerdctl](https://github.com/containerd/nerdctl). 
+
+It is recommended to run `colima nerdctl install` to install `nerdctl` alias script in $PATH.
+
 ### Kubernetes
 
 To enable Kubernetes, start Colima with `--with-kubernetes` flag.
-Colima uses minikube in background which requires at least 2CPUs and ~2.2GiB memory to run.
-
-Colima's Docker runtime is used for Kubernetes. Therefore, images built or pulled with Docker are accessible to Kubernetes.
 
 ```
 colima start --with-kubernetes
 ```
 
+#### Interacting with Image Registry
+
+For Docker runtime, images built or pulled with Docker are accessible to Kubernetes.
+
+For Containerd runtime, images built or pulled in the `k8s.io` namespace are accessible to Kubernetes.
+
+
 ### Customizing the VM
 
-The default VM created by Colima has 2 CPUs, 4GiB memory and 60GiB storage.
+The default VM created by Colima has 2 CPUs, 2GiB memory and 60GiB storage.
 
 The VM can be customized by passing `--cpu`, `--memory` and `--disk` to `colima start`.
 If VM is already created, stop the VM and apply the flags when starting it.
@@ -78,44 +100,48 @@ If VM is already created, stop the VM and apply the flags when starting it.
 
 To provide container runtimes on macOS with minimal setup.
 
-The current version is in usable alpha state and provides Docker and Kubernetes using Docker runtime.
-If there is enough interest in the project, the plan is a rewrite in Go with added flexibility to
-support other container runtimes (e.g. containerd/nerdctl, cri-o/podman).
-
 ## What is with the name?
 
-Colima means COntainers in LIMA
+Colima means Containers in Lima.
+
+Since Lima is aka Linux on Mac. By transitivity, Colima can also mean Containers on Linux on Mac.
 
 ## FAQ
 
 <details>
 <summary>Can it run alongside Docker for Mac?</summary>
 <p>
 
-No. Colima assumes to be the default Docker context and will conflict with Docker for Mac. You should run either, not both.
+No, except when started with Containerd runtime. Colima assumes to be the default Docker context and will conflict with Docker for Mac. You should run either, not both.
 
 </p>
 </details>
 
 <details>
-<summary>What about Docker Volumes and Docker Compose?</summary>
+<summary>How to enable writable volumes?</summary>
 <p>
 
-Colima mounts the host's $HOME directory as readonly in the VM. Volume mounts and docker compose should work as expected but only readonly.
+By default, Colima mounts the host's $HOME directory as readonly in the VM. Volume mounts and Compose should work as expected but only readonly.
 
-Colima uses Lima for the VM and Lima's support for writeable volumes is still experimental.
-Volumes are thereby made readonly in Colima for now.
+Colima uses Lima for the VM and Lima's support for writable volumes is still experimental.
+It is recommended to only mount the necessary directories as writable rather than the entire $HOME directory.
+
+The following mounts $HOME/projects and $HOME/work directories as writable.
+
+```
+colima start --mount $HOME/projects:w --mount $HOME/work:w
+```
 
 </p>
 </details>
 
 <details>
-<summary>What about Ports?</summary>
+<summary>How to customize Docker config e.g. add insecure registries?</summary>
 <p>
 
-Port forwarding are automatic and accessible on the macOS host.
+On first startup, Colima generates Docker daemon.json file at `$HOME/.colima/docker/daemon.json`.
 
-Currently, privileged ports are not forwarded i.e. ports (1-1023). This is a limitation of Lima.
+Simply modify the daemon.json file accordingly and restart Colima.
 
 </p>
 </details>
@@ -135,34 +161,26 @@ Minikube with Docker runtime can expose the cluster's Docker with `minikube dock
 - Kubernetes is not optional, even if you only need Docker.
 
 - All of minikube's free drivers for macOS fall-short in one of performance, port forwarding or volumes.
-  While port-forwarding and volumes are non-issue for Kubernetes, they can be deal breaker for Docker-only use.
+  While port-forwarding and volumes are non-issue for Kubernetes, they can be a deal breaker for Docker-only use.
 
 </p>
 </details>
 
+
 <details>
-<summary>How can I enable verbose output?</summary>
+<summary>Are M1 macs supported?</summary>
 <p>
 
-The log file is at $HOME/.colima/out.log, you can simply tail it.
-
-```
-tail -f $HOME/.colima/out.log
-```
+Colima is written to support M1 macs but not tested, as the author do not currently possess an M1 device.
 
 </p>
 </details>
 
-<details>
-<summary>What about M1 macs?</summary>
-<p>
-
-M1 m
65D6
acs should work, but not tested.
+## Help Wanted
 
-The challenge is installing Lima on M1 macs, instructions are available on [Lima project page](https://github.com/lima-vm/lima/blob/master/README.md#installation).
-
-</p>
-</details>
+- Homebrew formula
+- Documentation page
+- Testing on M1 Macs
 
 ## License