documentation

Author: André Schreck

README.md

@@ -33,13 +33,30 @@ No more elements are mapped or checked, because it is not necessary.
 
 ## Current Operators
 
-* filter
-* map
-* flatMap
-* distinct
-* first
-* some
-* every
+### Intermetiate Operators
+
+There can be as many intermediate operators as you want in a pipe. In an intermediate operator is the last operator of a pipe, the result of the pipe call will be an array.
+
+* __filter__<br />
+Gets a function that takes an element and returns a boolean. The elements where the function returns true survive.
+* __map__<br />
+Gets a function and applies each element to that function.
+* __flatMap__
+The operator gets a function that maps to an array of elements and flattens them.
+* __distinct__
+Removes duplicated elements. It's important to not, that this is a statefull operator.
+
+### Terminal Operators
+
+A terminal operator has to be the last one in a pipe. Also, there can only be on terminal operator in a pipe.<br />
+If the terminal operator 
+
+* __first__<br />
+Gets a function that takes an element and returns a boolean. If an element is evaluated to true that element is immediately returned by the pipe.
+* __some__<br />
+Some works similar to the `first`-operator except that not the element is returned, but the value `true` as soon as the passed function evaluates to true.
+* __every__<br />
+`every` also applies the passed function to each element. As soon as one element does not evaluate to `true` the pipe immediately returns `false`. 
 
 ## When is it usefull?