From 3caa1bd07f0fd5576b93f6050d75c61bdf8210fd Mon Sep 17 00:00:00 2001
From: iwilltry42 <thorsten.klein@trivago.com>
Date: Wed, 3 Apr 2019 10:27:09 +0200
Subject: [PATCH] update README

---
 LICENSE   |  2 +-
 README.md | 35 ++++++++++++++++++++++++++++++++++-
 2 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/LICENSE b/LICENSE
index abcd91d4..991e4c43 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Thorsten Klein
+Copyright (c) 2019 Thorsten Klein <iwilltry42@gmail.com>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
diff --git a/README.md b/README.md
index f9af6486..facaf142 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,36 @@
 # k3d-go
 
-[zeerorg/k3s-in-docker](https://github.com/zeerorg/k3s-in-docker) reimplemented in Golang... just because I didn't have time to learn Rust.
+## k3s in docker
+
+k3s is the lightweight Kubernetes distribution by Rancher: [rancher/k3s](https://github.com/rancher/k3s)
+This repository is basically [zeerorg/k3s-in-docker](https://github.com/zeerorg/k3s-in-docker) reimplemented in Golang... just because I didn't have time to learn Rust.
+Also I've added some functionality.
+
+## Requirements
+
+- docker
+
+## Install
+
+Grab a release from the [release tab](https://github.com/iwilltry42/k3d-go/releases).
+
+or...
+
+## Build
+
+1. Clone this repo, e.g. via `go get -u github.com/iwilltry42/k3d-go/releases`
+2. Inside the repo run
+   - `make bootstrap` to install build tools and then `make build` to build for your current system
+   - `go install` to install it to your `GOPATH`
+   - `make build-cross` to build for all systems
+
+## Usage
+
+Check out what you can do via `k3d help`
+
+Example Workflow: Create a new cluster and use it with `kubectl`
+
+1. `k3d create` to create a new single-node cluster (docker container)
+2. `export KUBECONFIG=$(k3d get-kubeconfig)` to make `kubectl` to use the kubeconfig for that cluster
+3. execute some commands like `kubectl get pods --all-namespaces`
+4. `k3d delete` to delete the default cluster
\ No newline at end of file