Skip to content

Commit

Permalink
Add test documentation. Fixes #61
Browse files Browse the repository at this point in the history
  • Loading branch information
tmcw committed May 10, 2014
1 parent 7fc0882 commit 3762072
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,23 @@ Yields:
]
```

### Tests

This project is tested with [nodeunit](https://github.com/caolan/nodeunit).

To run tests, you'll need to install this project from source and install its
node dependencies:

```
git clone [email protected]:unitedstates/citation.git
cd citation
npm install
npm test
```

Test cases are stored in the `test` directory. Each test case covers a subsection
of the code and ensures that citations are correctly detected: for instance, see
[test/stat.js](test/stat.js).

## Public domain

Expand Down

0 comments on commit 3762072

Please sign in to comment.