noun - npm Package Compare versions

Comparing version 0.1.1 to 0.1.3

.verbrc.md

@@ -8,4 +8,24 @@ ---
 
-Noun makes it easy to extend your application with basic plugin functionality. See the [examples](./example.js) and [tests](./test) for a better understanding of how Noun works.
+Noun makes it easy to extend your application with basic plugin functionality.
 
+
+## Usage
+
+```js
+var Noun = require('{%= name %}');
+```
+
+By default, plugins named `noun-*` are automatically loaded from `node_modules`. Pass a `namespace` to
+use your own naming convention:
+
+```js
+// load plugins named `my-app-*`
+var noun = new Noun('my-app');
+```
+
+_**Note** that plugins are only loaded if they are listed in `dependencies` or `devDependencies` in package.json._
+
+See the [examples](./example.js) and [tests](./test) for a better understanding of how Noun works.
+
+
 ## Install
@@ -20,9 +40,2 @@ {%= include("install-npm", {save: true}) %}
 
-## Usage
-
-```js
-var Noun = require('{%= name %}');
-var noun = new Noun();
-```
-
 ## API
@@ -29,0 +42,0 @@ {%= jscomments("index.js") %}

index.js

@@ -26,3 +26,3 @@ /*!
 function Noun(namespace, source) {
-  this.namespace = namespace || 'noun';
+  this._namespace = namespace || 'noun';
   extend(this, source || {});
@@ -72,6 +72,6 @@ this.loadPlugins();
 Noun.prototype.loadPlugins = function(pattern) {
-  var name = pattern || this.namespace + '-*';
+  var name = pattern || this._namespace + '-*';
 
   return this.plugins = load(name, {
-    omit: this.namespace,
+    omit: this._namespace,
     cwd: process.cwd()
@@ -78,0 +78,0 @@ });

package.json

 {
   "name": "noun",
   "description": "`.use()` plugins to manipulate objects. Easy to use and extend. Load locally defined plugins, or define a namespace to automatically load plugins from load modules.",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "homepage": "https://github.com/jonschlinkert/noun",
@@ -39,6 +39,16 @@ "author": {
   },
-  "keywords": [],
+  "keywords": [
+    "fn",
+    "functions",
+    "load",
+    "middleware",
+    "object",
+    "plugin",
+    "plugins",
+    "run",
+    "use"
+  ],
   "dependencies": {
     "load-plugins": "^0.2.0"
   }
-}
+}

README.md

@@ -5,4 +5,24 @@ # noun [![NPM version](https://badge.fury.io/js/noun.svg)](http://badge.fury.io/js/noun)
 
-Noun makes it easy to extend your application with basic plugin functionality. See the [examples](./example.js) and [tests](./test) for a better understanding of how Noun works.
+Noun makes it easy to extend your application with basic plugin functionality.
 
+
+## Usage
+
+```js
+var Noun = require('noun');
+```
+
+By default, plugins named `noun-*` are automatically loaded from `node_modules`. Pass a `namespace` to
+use your own naming convention:
+
+```js
+// load plugins named `my-app-*`
+var noun = new Noun('my-app');
+```
+
+_**Note** that plugins are only loaded if they are listed in `dependencies` or `devDependencies` in package.json._
+
+See the [examples](./example.js) and [tests](./test) for a better understanding of how Noun works.
+
+
 ## Install
@@ -21,9 +41,2 @@ #### Install with [npm](npmjs.org)
 
-## Usage
-
-```js
-var Noun = require('noun');
-var noun = new Noun();
-```
-
 ## API
@@ -30,0 +43,0 @@ ### [Noun](index.js#L25)

No alert changes

Improved metrics

Total package byte prevSize

14739

5.29%

Number of lines in readme file

117

12.5%

No dependency changes