docs(readme): update example (#28)

siderolabs · Jul 22, 2017 · daa39f3 · daa39f3
1 parent 9383d3e
commit daa39f3
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 11 deletions.
diff --git a/.conform.yaml b/.conform.yaml
@@ -17,6 +17,7 @@ policies:
         - "git"
         - "metadata"
         - "policy"
+        - "readme"
         - "renderer"
         - "*"
 

diff --git a/README.md b/README.md
@@ -27,28 +27,36 @@ 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:
       types:
         - "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
 ```