add readmewiki

1 files changed, 30 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c8d7ee1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# buildkite-agent
+
+Install and configure `buildkite-agent`.
+
+##### requirements.yml
+
+```yaml
+roles:
+  - src: git+https://git.segundo.io/Ansible/buildkite-agent
+    name: buildkite-agent
+```
+
+### Example playbook
+
+```yaml
+---
+- hosts: foo
+  roles:
+    - role: buildkite-agent
+      vars:
+        buildkite_config:
+          - key: token
+            value: "{{ buildkite.agent_token }}"
+          - key: spawn
+            value: 1
+            quote: false
+        buildkite_extra_packages: [make]
+        buildkite_environment_hook: |
+          export DOCKER_HUB_PASSWORD="{{ dockerhub.token }}"
+```