From be8863fa695ba8f3809c4a78bbb053fa1acc668c Mon Sep 17 00:00:00 2001
From: Ryan <ryan@andthensome.nl>
Date: Tue, 4 Oct 2016 23:57:46 +0200
Subject: [PATCH] updated README

---
 README.md        | 51 +++++++++++++++++++++++++++++++++++++++++++++++-
 wercker-step.yml |  2 +-
 2 files changed, 51 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index ec17dc8..81e9797 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,50 @@
-Fill me!
\ No newline at end of file
+# Wercker Step Surge Deploy
+
+This step wil deploy your site to [Surge.sh](https://surge.sh/) using the [surge cli client](https://www.npmjs.com/package/surge).
+
+# Requirements
+
+This step requires a container with [npm](https://www.npmjs.com/) installed.
+
+# Parameters
+
+## login (required)
+
+The surge.sh login. The login can be echoed by running
+
+```shell
+surge token
+```
+
+locally.
+
+## directory (optional)
+
+The directory to de deployed. Defaults to public.
+
+## token (required)
+
+The surge.sh token. The login can be echoed by running
+
+```shell
+surge token
+```
+
+locally.
+
+## domain (required)
+
+Domain to be used with surge.sh hosting.
+
+# Example wercker.yml (Docker)
+
+```yml
+box: andthensome/alpine-surge-bash
+deploy:
+  steps:
+    - alrayyes/surge-deploy:
+        login: "user@example.com"
+        directory: "public"
+        token: "94a08da1fecbb6e8b46990538c7b50b2"
+        domain: "example.com"
+```
\ No newline at end of file
diff --git a/wercker-step.yml b/wercker-step.yml
index 56384ca..f7e2a85 100644
--- a/wercker-step.yml
+++ b/wercker-step.yml
@@ -1,5 +1,5 @@
 name: surge-deploy
-version: 0.1.8
+version: 0.1.9
 description: Deploys a directory to surge.sh.
 keywords:
   - deploy