From 6b999fc01f00c26e58ab64effc104c49ee45fdb3 Mon Sep 17 00:00:00 2001 From: Luke Childs Date: Thu, 27 Jul 2017 06:31:07 +0100 Subject: [PATCH] Add better description to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index be5f383..051bfbc 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,10 @@ [![Coverage Status](https://coveralls.io/repos/github/lukechilds/requireable/badge.svg?branch=master)](https://coveralls.io/github/lukechilds/requireable?branch=master) [![npm](https://img.shields.io/npm/v/requireable.svg)](https://www.npmjs.com/package/requireable) +Mocks the require command to include the current package when the the `name` from the current packages `package.json` is required. + +Especially useful in tests if you want to require the package you're testing by name rather than relative paths. + ## Install ```shell