Documentation improvements

.github/workflows/test.yaml

@@ -2,15 +2,9 @@ on:
   push:
     branches:
       - master
-    paths:
-      - '**/src/*'
-      - '.github/workflows/*'
   pull_request:
-    paths:
-      - '**/Cargo.toml'
-      - '**/src/*'
-      - '.github/workflows/*'
-
+    branches:
+      - master
 
 name: library-tests
 

examples/all-types/customers.yaml

@@ -1,5 +1,7 @@
 ---
-- name: Teodor Fælgen
+- name:
+    first name: Teodor
+    last name: Fælgen
   cars:
     work:
       year: 1908

examples/all-types/schema.yaml

@@ -13,18 +13,37 @@ schema:
         type: string
     price: 
       type: real
+      minimum: 0.00
+
+---
+uri: customer-name
+schema:
+  oneOf:
+    - type: object
+      items:
+        first name:
+          type: string
+        last name:
+          type: string
+      required:
+        - first name
+        - last name
+    - type: string
 
 ---
 uri: customer
 schema:
   type: object
   items:
     name:
-      type: string
+      $ref: customer-name
     cars:
       type: hash
       items:
         $ref: car
+  required:
+    - name
+    - cars
 
 ---
 uri: customer-list

examples/locating-errors/README.md

@@ -0,0 +1,9 @@
+This example is designed to *fail* the schema validation, it is not an example of a valid schema/yaml file setup!
+
+Use the following command to show an example of the error codes produced by this tool, when validation fails:
+```shell
+yaml-validator-cli        \
+    --schema schema.yaml  \
+    --uri phonebook       \
+    phonebook.yaml
+```

examples/locating-errors/phonebook.yaml

@@ -3,10 +3,4 @@
 - name: Karen
   age: 12.5
 - name: 200
-  age: Jimmy
-
-# example usage:
-# yaml-validator-cli        \
-#     --schema schema.yaml  \
-#     --uri phonebook       \
-#     phonebook.yaml
+  age: Jimmy

examples/multiple-schemas/README.md

@@ -0,0 +1,9 @@
+This example demonstrates a schema specified in multiple separate files, and then using the following command line to validate a single yaml file ('mybook.yaml') against a single root uri (`phonebook` defined in [phonebook-schema.yaml](phonebook-schema.yaml)) within the context of these files:
+
+```shell
+yaml-validator-cli                  \
+   --schema person-schema.yaml     \
+   --schema phonebook-schema.yaml  \
+   --uri phonebook                 \
+   mybook.yaml
+```

examples/multiple-schemas/mybook.yaml

@@ -3,11 +3,4 @@ phonebook:
   - name: timmy
     phone: 123456
   - name: tammy
-    phone: 987654
-
-# example usage:
-# yaml-validator-cli                  \
-#     --schema person-schema.yaml     \
-#     --schema phonebook-schema.yaml  \
-#     --uri phonebook                 \
-#     mybook.yaml
+    phone: 987654