README-driven development

README.md

@@ -1,2 +1,23 @@
 # kubelwagen
-FUSE mount dev environments into Kubernetes
+*Getting your dev environment to the front lines*
+
+It's great to have a consistent environment in containers, and it's great to have services run on Kubernetes, but it's a pain to build dev containers to be run as pods on Kubernetes.
+
+It would be great if your live development working directory could be mounted into a running pod on the powerful metal in the cloud. Plus, it would obviate the need for workaround services such as (localhost.dev or something?) to share a running WIP instance as it would have a valid service on the dev cluster, ingressable and everything.
+
+Kubelwagen is a sidecar container that provides a FUSE directory to the running pod that is mounted in from a client connecting in over HTTP.
+
+
+## Setting it up
+
+```
+kubelwagen serve [LISTEN HOSTPORT] [TARGET DIRECTORY]
+```
+
+```
+kubelwagen connect [TARGET ADDRESS] [SOURCE DIRECTORY]
+```
+
+## Licensing
+
+Distributed under the GPL, as it's a dev tool and not meant as a product. Use it internally. Share alike.