From 532b9bb39aba537e9d2512e536a486d4e787b264 Mon Sep 17 00:00:00 2001
From: Simon Menke <simon.menke@gmail.com>
Date: Wed, 18 May 2016 11:51:25 +0200
Subject: [PATCH] Create README.md

---
 README.md | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..49eb38f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# heroku-utils
+
+
+# `x-heroku release <app>`
+
+This command makes and uploads a new heroku slug from a tar file after which the slug will be released as
+a new version of the app. 
+
+The input tar file MUST contain a `.heroku.json` file and all application assets/executables.
+
+```
+-rw-r--r--  0 root   root       52 Feb  1  1988 .heroku.json
+drwxr-xr-x  0 root   root        0 Feb  1  1988 bin/
+-rwxr-xr-x  0 root   root  7601672 Feb  1  1988 bin/hello
+```
+
+The content of the `.heroku.json` file must match the following example:
+
+```json5
+{
+  // required
+  "process_types": {
+    "web": "bin/hello"
+    // ...
+  },
+  
+  // optional
+  "commit": "71763e53638e91d778ceda3de420cc3a7473b0e4",
+  "commit_description": "Commit message or description",
+  "buildpack_provided_description": "Golang app",
+  "stack": "cedar-14"
+}
+```
+
+