README

README.md

@@ -0,0 +1,81 @@
+Terraform: Kubernetes
+=====================
+
+[![CircleCI](https://circleci.com/gh/previousnext/terraform-provider-k8s.svg?style=svg)](https://circleci.com/gh/previousnext/terraform-provider-k8s)
+
+**Maintainer**: Nick Schuch
+
+Terraform provider for Kubernetes.
+
+## Compared to core Kubernetes provider
+
+* We support APIs outside of the "v1" space eg. Deployment, Daemonset, Cronjob etc.
+* We don't wait for manifests to deploy - Service Object to get a load balancer provisioned.
+
+## Development
+
+### Getting started
+
+For steps on getting started with Go:
+
+https://golang.org/doc/install
+
+To get a checkout of the project run the following commands:
+
+```bash
+# Make sure the parent directories exist.
+mkdir -p $GOPATH/src/github.com/previousnext
+
+# Checkout the codebase.
+git clone [email protected]:previousnext/terraform-provider-k8s $GOPATH/src/github.com/previousnext/terraform-provider-k8s
+
+# Change into the project to run workflow commands.
+cd $GOPATH/src/github.com/previousnext/terraform-provider-k8s
+```
+
+### Documentation
+
+See `/docs`
+
+### Resources
+
+* [Dave Cheney - Reproducible Builds](https://www.youtube.com/watch?v=c3dW80eO88I)
+* [Bryan Cantril - Debugging under fire](https://www.youtube.com/watch?v=30jNsCVLpAE&t=2675s)
+* [Sam Boyer - The New Era of Go Package Management](https://www.youtube.com/watch?v=5LtMb090AZI)
+* [Kelsey Hightower - From development to production](https://www.youtube.com/watch?v=XL9CQobFB8I&t=787s)
+
+### Tools
+
+```bash
+# Dependency management
+go get -u github.com/golang/dep/cmd/dep
+
+# Testing
+go get -u github.com/golang/lint/golint
+
+# Release management.
+go get -u github.com/tcnksm/ghr
+
+# Build
+go get -u github.com/mitchellh/gox
+```
+
+### Workflow
+
+**Testing**
+
+```bash
+make lint test
+```
+
+**Building**
+
+```bash
+make build
+```
+
+**Releasing**
+
+```bash
+make release
+```