Skip to content

Commit

Permalink
Make testing usage clear
Browse files Browse the repository at this point in the history
  • Loading branch information
lukechilds committed Jul 27, 2017
1 parent 50e3a17 commit 67fea46
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,9 @@
[![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.
Mocks the require command to include the current package when the `name` from the current `package.json` is required.

Especially useful in tests if you want to require the package you're testing by name rather than relative paths.
Uses `process.cwd()` to find the current `package.json` so this is only meant to be used as a dev dependency for testing. This will not work on a published package!

## Install

Expand Down

0 comments on commit 67fea46

Please sign in to comment.