Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bahmutov committed May 22, 2014
1 parent 213388d commit ba72067
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 2 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,24 @@ a message if condition is false
lazyAss(typeof foo === 'object', 'expected', foo, 'to be an object');
```

## Install

Node: `npm install lazy-ass --save` then `var lazyAss = require('lazy-ass');`

Browser: `bower install lazy-ass --save`, makes function available as `window.lazyAss`.

## Notes

You can pass as many arguments to *lazyAss* after the condition. The condition
will be evaluated every time (this is required for any assertion). The rest of arguments
will be concatenated according to rules

* string will be left unchanged.
* function will be called and its output will be concatenated.
* any array or object will be JSON stringified.

There will be single space between the individual parts.

### Small print

Author: Gleb Bahmutov © 2014
Expand Down
2 changes: 1 addition & 1 deletion bower.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "lazy-ass",
"main": "index.js",
"version": "0.1.1",
"version": "0.1.2",
"homepage": "https://github.com/bahmutov/lazy-ass",
"license": "MIT",
"ignore": [
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "lazy-ass",
"description": "Lazy assertions without performance penalty",
"version": "0.1.1",
"version": "0.1.2",
"author": "Gleb Bahmutov <gleb.bahmutov@gmail.com>",
"bugs": {
"url": "https://github.com/bahmutov/lazy-ass/issues"
Expand Down

0 comments on commit ba72067

Please sign in to comment.