From 70d07f1a4c8030aba378df12eadcbb7798a936b2 Mon Sep 17 00:00:00 2001
From: Chris Brown <xoebus@xoeb.us>
Date: Fri, 21 Aug 2015 11:35:43 -0700
Subject: [PATCH] add usage examples to README

---
 README.md | 28 ++++++++++++++++++++++++++++
 1 file changed, 28 insertions(+)

diff --git a/README.md b/README.md
index 56e0c98..250c9c6 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,9 @@
 
 Fetches and creates versioned GitHub resources.
 
+> If you're seeing rate limits affecting you then please add a token to the source
+> configuration. This will increase your number of allowed requests.
+
 ## Source Configuration
 
 * `user`: *Required.* The GitHub username or organization name for the
@@ -15,6 +18,31 @@ Fetches and creates versioned GitHub resources.
 * `github_api_url`: *Optional.* If you use a non-public GitHub deployment then
   you can set your API URL here.
 
+### Example
+
+``` yaml
+- name: gh-release
+  type: github-release
+  source:
+    user: concourse
+    repository: concourse
+    access_token: abcdef1234567890
+```
+
+``` yaml
+- get: gh-release
+```
+
+``` yaml
+- put: gh-release
+  params:
+    name: path/to/name/file
+    tag: path/to/tag/file
+    body: path/to/body/file
+    globs:
+    - paths/to/files/to/upload-*.tgz
+```
+
 ## Behavior
 
 ### `check`: Check for released versions.