Add README.mdwiki

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..3048f58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+# concourse
+
+A versioned catalogue of re-usable Concourse bits
+
+## Usage
+
+Include the following resource in the pipeline where you wish to consume a
+task:
+
+```yaml
+- name: concourse
+  type: git
+  source:
+    uri: https://git.segundo.io/concourse
+```
+
+To use a task, ensure that you `get: concourse` earlier in your plan. Remember
+to perform any input/output mapping from the generic names _inside_ the task
+(on the left of the colon), to your specific names _outside_ the task (on the
+right of the colon).
+
+```yaml
+jobs:
+  name: do-the-thing
+  plan:
+  - get: concourse-tasks
+    # ...
+  - task: tarball-files
+    file: concourse-tasks/tar/task.yml
+    input_mapping: { input: your-directory }
+    output_mapping: { output: name-you-want }
+    params:
+      INCLUDE: file1 file2
+      TARBALL_NAME: my-tarball
+```