From daa39f36a0376e1e4767da5e43d13f0ec1b2c838 Mon Sep 17 00:00:00 2001 From: Andrew Rynhard Date: Sat, 22 Jul 2017 15:46:10 -0700 Subject: [PATCH] docs(readme): update example (#28) --- .conform.yaml | 1 + README.md | 30 +++++++++++++++++++----------- 2 files changed, 20 insertions(+), 11 deletions(-) diff --git a/.conform.yaml b/.conform.yaml index 6e1ac02c..0b9e5ce3 100644 --- a/.conform.yaml +++ b/.conform.yaml @@ -17,6 +17,7 @@ policies: - "git" - "metadata" - "policy" + - "readme" - "renderer" - "*" diff --git a/README.md b/README.md index f40d5358..92cd283f 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,11 @@ The key features of Conform are: Getting Started --------------- -Create a file named `conform.yaml` with the following contents: +Create a file named `.conform.yaml` with the following contents: ```yaml metadata: - repository: example + repository: hello/world + policies: - type: conventionalCommit spec: @@ -38,17 +39,24 @@ policies: - "type" scopes: - "scope" - - type: branch - spec: - name: master - pipelines: - - name: example -pipelines: - example: - stages: - - example + +script: + template: | + #!/bin/bash + + echo "Hello, world!" + +pipeline: + stages: + - example + stages: example: + tasks: + - task + +tasks: + task: template: | FROM scratch ```