Add chnagelog and docs

CHANGELOG.md

@@ -1,3 +1,7 @@
+# v2.3.0
+
+ - Add property `skip`, adds the ability to skip test cases 
+
 # v2.2.0
 
  - Move from `github.com/SimonBaeumer` to `github.com/commander-cli`

README.md

@@ -41,6 +41,7 @@ For more information take a look at the [quick start](#quick-start), the [exampl
       * [not-contains](#not-contains)
       * [xml](#xml)
     - [stderr](#stderr)
+    - [skip](#skip)
   + [Config](#user-content-config-config)
     - [dir](#dir)
     - [env](#env)
@@ -146,6 +147,11 @@ tests:
         stdout: hello # Default is to check if it contains the given characters
         exit-code: 0 # Assert exit-code
 
+    it should skip:
+        command: echo "I should be skipped"
+        stdout: I should be skipped
+        skip: true
+
     it should fail:
         command: invalid
         stderr:
@@ -162,7 +168,8 @@ tests:
             xml:
                 "//book//auhtor": Steven King # Make assertions on xml documents
         exit-code: 127
-
+        skip: false
+
     it has configs:
         command: echo hello
         stdout:
@@ -536,6 +543,20 @@ See [stdout](#stdout) for more information.
     line-count: 1
 ```
 
+#### skip
+
+`skip` is a `boolean` type, setting this field to `true` will skip the test case.
+
+ - name: `skip`
+ - type: `bool`
+ - default: `false`
+
+```yaml
+echo test:
+  stdout: test
+  skip: true
+```
+
 ### <a name="config-config"></a>Config
 
 You can add configs which will be applied globally to all tests or just for a specific test case, i.e.:

examples/commander.yaml

@@ -22,5 +22,6 @@ tests:
     exit-code: 127
 
   it should skip:
-    command: echo hello
+    command: echo "I should be skipped"
+    stdout: I should be skipped
     skip: true