optional-require - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "optional-require",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Optional Require",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -1,2 +0,25 @@
-# optional-require
-Optional Require
+# Optional Require
+
+Allows you to require a module only if it exists.
+
+# Usage
+
+```js
+const optionalRequire = require("optional-require")(require);
+
+const foo = optionalRequire("foo") || {};
+const bar = optionalRequire("bar", true); // true enables console.log a message
+const xyz = optionalRequire("xyz", "test"); // "test" enables console.log a message with "test" added.
+const fbPath = optionalRequire.resolve("foo", "foo doesn't exist");
+```
+
+# Install
+
+```bash
+$ npm i optional-require --save
+```
+
+# LICENSE
+
+Apache-2.0 © [Joel Chen](https://github.com/jchip)
+

No alert changes

Improved metrics

Number of lines in readme file

26

766.67%

Worsened metrics

Total package byte prevSize

1912

-24.46%

Number of package files

4

-42.86%

Lines of code

21

-58.82%

No dependency changes