Merge pull request #44 from kentcdodds/pr/extend-expect

Add extend-expect file

README.md

@@ -40,6 +40,9 @@ it('should demonstrate this matcher`s usage', async () => {
 
 ![Screenshot of the resulting output from the usage example](example-cli.png)
 
+> Note, you can also simply require `'jest-axe/extend-expect'` which will call `expect.extend` for you.
+> This is especially helpful when using the jest `setupFiles` configuration.
+
 ### With React
 
 ```javascript

extend-expect.js

@@ -0,0 +1,8 @@
+// this allows users to simply add `require('jest-axe/extend-expect')`
+// at the top of their test file rather than have two lines for this.
+// it also allows users to use jest's setupFiles configuration and
+// point directly to `jest-axe/extend-expect`
+const { toHaveNoViolations } = require('jest-axe')
+
+expect.extend(toHaveNoViolations)
+

package.json

@@ -5,7 +5,8 @@
   "repository": "nickcolley/jest-axe",
   "main": "index.js",
   "files": [
-    "index.js"
+    "index.js",
+    "extend-expect.js"
   ],
   "scripts": {
     "test": "jest"