Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

more infos about project added

  • Loading branch information...
commit a8e852f7542da34aa87787384bd94f81dd49f34f 1 parent dbf51d6
@danseid authored
Showing with 32 additions and 1 deletion.
  1. +32 −1 README.md
View
33 README.md
@@ -6,12 +6,43 @@
*Katchers* is using Kotlin infix notation to provide a domain specific language (DSL) for expressing assertions in tests using the word *should*.
+
##Usage
+--------------------
+
+
__1. Import `import org.katchers.*`__
__2. Write assertions `1 should be equal 1`__
+##Syntax
+
+--------------------
+
+Every matcher expression starts with a *__result__* we want to validate, followed by *__should__*, a *__verb__(i.e.: be, have, contain ...)*, *__matchfunction__(depends on type of result and verb we are using)* and *__expected value__(depends on matchfunction)*.
+
+ <result|object> should <verb> <matchfunction> <expected>
+###Negation of verbs
+Every verb can be negated by __!__ operator
+
+ 1 should !be equal 2
+
+##List of katchers
+
+--------------------
+
+###Any
+Any matchers may be used on any type of object.
+####be | !be equal
+equal matchfunction should only be used on types, that implement equals function correctly
+ 1 should be equal 1 //✔
+ 2 should !be equal 1 //✔
+ "string" should be equal "string" //✔
+ "string" should be equal "str" //✘
+####be | !be any
-##Examples
+###String
+####
+###Function
Please sign in to comment.
Something went wrong with that request. Please try again.