Skip to content

Commit

Permalink
Add basic usage instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
stevehopkinson authored Feb 4, 2017
1 parent 9767c12 commit a195eeb
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,7 @@
# Assert Equals
A lightweight assert-equals function for use in inline testing.

## Usage
1. Save ```assert-equals.js``` to your project directory.
2. Use ```const assertEquals = require('./[pathToFile]/assert-equals')``` to import the function.
3. Test whether two values/objects are equal using ```assertEquals(valueA, valueB)```.

0 comments on commit a195eeb

Please sign in to comment.