Skip to content

Commit

Permalink
Readme tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
Łukasz Kużyński committed Oct 14, 2017
1 parent 313c5c9 commit 3c9a69d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions README.MD
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Set of various predicates for type checking, simple assertions, filtering etc.

## Features
* written in typescript (with [type guards](#type-guards) and function overloading)
* well defined [API design principles](#design)
* well defined [API design principles](#api-design)
* predicates description every predicate contains a proper description for easier debugging and automatic assertion generation
* supports simple type checks with unnecessary verbosity
* every predicate supports currying if possible
Expand All @@ -16,6 +16,7 @@ Set of various predicates for type checking, simple assertions, filtering etc.
```
npm install predicates
```
## [Full API](API.md)

## Example

Expand Down Expand Up @@ -62,8 +63,6 @@ new Person('Tom', 'Welling'); // OK!
new Person('Tom', '', 33); // Error: Surname must be a string and cannot be emptye
```

## [Full API](API.md)

## API design

### Generated predicates can be called with more than one argument
Expand Down

0 comments on commit 3c9a69d

Please sign in to comment.