From 52ebd27d7d6aa584b72a11331b2aa880b6db6c28 Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Thu, 27 Jul 2017 06:38:13 +0100 Subject: [PATCH] Add AVA usage section to readme --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index f2e7cd8..c680331 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,20 @@ require('requirable'); That's it! You can now do `require('package-name')`. +## AVA Usage + +Some tests runners such as AVA can require packages automatically for you. If you're using AVA add the following to your package.json: + +```json +"ava": { + "require": [ + "requireable" + ] +}, + ``` + + You can now `require` your package in your AVA tests. + ## License MIT © Luke Childs