Skip to content

Commit

Permalink
[minor] minimal readme
Browse files Browse the repository at this point in the history
  • Loading branch information
3rd-Eden committed Jul 8, 2014
1 parent 1970369 commit cefacc4
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 1 deletion.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Illuminati

### Installation

```
npm install --save-dev illuminati
```

### Usage

Using `illuminati` as test runner is super simple. The only thing you need to
add to your `package.json` is the `illuminati` command in the `scripts.test`
property:

```js
{
"scripts": {
"test": "illuminati"
}
}
```

If you wish to run the tests in `phantomjs` instead you can simply append the
`--phantom` flag and it will do it's thing.

```
{
"scripts": {
"test": "illuminati --phantom"
}
}
```

And that is it. Super simple, but highly opinionated testing.

### License

MIT
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "illuminati",
"version": "0.0.0",
"version": "0.0.1",
"description": "secret society",
"main": "index.js",
"scripts": {
Expand Down

0 comments on commit cefacc4

Please sign in to comment.