base - npm Package Compare versions

Comparing version 0.13.0 to 0.13.1

index.js

@@ -270,3 +270,2 @@ 'use strict';
    * //=> 'bar'
-   * // and now you know how to get to third base ;)
    * ```
@@ -273,0 +272,0 @@ * @name .base

package.json

 {
   "name": "base",
-  "description": "Framework for rapidly creating high quality node.js applications, using plugins like building blocks",
-  "version": "0.13.0",
+  "description": "Framework for rapidly creating high quality, server-side node.js applications, using plugins like building blocks",
+  "version": "0.13.1",
   "homepage": "https://github.com/node-base/base",
@@ -12,7 +12,7 @@ "author": "Jon Schlinkert (https://github.com/jonschlinkert)",
   "contributors": [
-    "<[e-mail]> (https://github.com/wtgtybhertgeghgtwtg)",
-    "Brian Woodward <[e-mail]> (https://twitter.com/doowb)",
-    "Charlike Mike Reagent (https://i.am.charlike.online)",
+    "Brian Woodward (https://twitter.com/doowb)",
     "John O'Donnell (https://github.com/criticalmash)",
-    "Jon Schlinkert <[e-mail]> (http://twitter.com/jonschlinkert)"
+    "Jon Schlinkert (http://twitter.com/jonschlinkert)",
+    "tunnckoCore (https://i.am.charlike.online)",
+    "(https://github.com/wtgtybhertgeghgtwtg)"
   ],
@@ -36,7 +36,7 @@ "repository": "node-base/base",
     "arr-union": "^3.1.0",
-    "cache-base": "^1.0.0",
+    "cache-base": "^1.0.1",
     "class-utils": "^0.3.5",
     "component-emitter": "^1.2.1",
-    "define-property": "^0.2.5",
-    "isobject": "^3.0.0",
+    "define-property": "^1.0.0",
+    "isobject": "^3.0.1",
     "mixin-deep": "^1.2.0",
@@ -46,7 +46,7 @@ "pascalcase": "^0.1.1"
   "devDependencies": {
-    "gulp-format-md": "^0.1.11",
+    "gulp-format-md": "^1.0.0",
     "helper-changelog": "^0.3.0",
-    "mocha": "^3.2.0",
+    "mocha": "^3.5.3",
     "through2": "^2.0.3",
-    "verb-generate-readme": "^0.4.3"
+    "verb-generate-readme": "^0.6.0"
   },
@@ -68,3 +68,3 @@ "keywords": [
     "run": true,
-    "toc": false,
+    "toc": "collapsible",
     "layout": null,
@@ -71,0 +71,0 @@ "tasks": [

README.md

@@ -15,2 +15,19 @@ <p align="center">
 
+- [Why use Base?](#why-use-base)
+  * [Guiding principles](#guiding-principles)
+  * [Minimal API surface](#minimal-api-surface)
+  * [Composability](#composability)
+- [Install](#install)
+- [Install](#install-1)
+- [Usage](#usage)
+- [API](#api)
+- [Toolkit suite](#toolkit-suite)
+- [About](#about)
+  * [Related projects](#related-projects)
+  * [Tests](#tests)
+  * [Contributing](#contributing)
+  * [Release History](#release-history)
+  * [Authors](#authors)
+  * [License](#license)
+
 </details>
@@ -23,8 +40,8 @@
 
-Base is the foundation for creating modular, unit testable and highly pluggable node.js applications.
+Base is a foundation for creating modular, unit testable and highly pluggable server-side node.js APIs.
 
 * Go from zero to working application within minutes
+* Use [community plugins](https://www.npmjs.com/browse/keyword/baseplugin) to add feature-functionality to your application
 * Create your own custom plugins to add features
-* Use [community plugins](https://www.npmjs.com/browse/keyword/baseplugin) to add feature-functionality to your application
-* Plugins are stackable, so you can build up [more sophisticated applications](#toolkit-suite) from simpler plugins. Moreover, those applications can also be used as plugins themselves.
+* Like building blocks, plugins are stackable. Allowing you to build [sophisticated applications](#toolkit-suite) from simple plugins. Moreover, those applications can also be used as plugins themselves.
 
@@ -40,3 +57,7 @@ Most importantly, once you learn Base, you will be familiar with the core API of all applications built on Base. This means you will not only benefit as a developer, but as a user as well.
 * **Easy to test**: No special setup should be required to unit test `Base` or base plugins
+* **100% Node.js core style**
 
+  - No API sugar (left for higher level projects)
+  - Written in readable vanilla JavaScript
+
 ### Minimal API surface
@@ -302,3 +323,3 @@
 
-### [.base](index.js#L276)
+### [.base](index.js#L275)
 
@@ -332,6 +353,5 @@ Getter/setter used when creating nested instances of `Base`, for storing a reference to the first ancestor instance. This works by setting an instance of `Base` on the `parent` property of a "child" instance. The `base` property defaults to the current instance if no `parent` property is defined.
 //=> 'bar'
-// and now you know how to get to third base ;)
 ```
 
-### [#use](index.js#L301)
+### [Base.use](index.js#L300)
 
@@ -356,3 +376,3 @@ Static method for adding global plugin functions that will be added to an instance when created.
 
-### [#extend](index.js#L345)
+### [Base.extend](index.js#L344)
 
@@ -380,3 +400,3 @@ Static method for inheriting the prototype and static methods of the `Base` class. This method greatly simplifies the process of creating inheritance-based applications. See [static-extend](https://github.com/jonschlinkert/static-extend) for more details.
 
-### [#mixin](index.js#L387)
+### [Base.mixin](index.js#L386)
 
@@ -400,3 +420,3 @@ Used for adding methods to the `Base` prototype, and/or to the prototype of child instances. When a mixin function returns a function, the returned function is pushed onto the `.mixins` array, making it available to be used on inheriting classes whenever `Base.mixins()` is called (e.g. `Base.mixins(Child)`).
 
-### [#mixins](index.js#L409)
+### [Base.mixins](index.js#L408)
 
@@ -417,3 +437,3 @@ Static method for running global mixin functions against a child constructor. Mixins must be registered before calling this method.
 
-### [#inherit](index.js#L429)
+### [Base.inherit](index.js#L428)
 
@@ -436,3 +456,3 @@ Similar to `util.inherits`, but copies all static properties, prototype properties, and getters/setters from `Provider` to `Receiver`. See [class-utils](https://github.com/jonschlinkert/class-utils#inherit) for more details.
 
-Base is used as the foundation for all of the applications in the [toolkit suite](https://github.com/node-toolkit/getting-started) (except for [enquirer](https://github.com/enquirer/enquirer)):
+Base is used as the foundation for all of the applications in the [toolkit suite](https://github.com/node-toolkit/getting-started) (except for [enquirer](http://enquirer.io)):
 
@@ -443,3 +463,3 @@ **Building blocks**
 * [templates](https://github.com/jonschlinkert/templates): API for managing template collections and rendering templates with any node.js template engine. Can be used as the basis for creating a static site generator, blog framework, documentaton system, and so on.
-* [enquirer](https://github.com/enquirer/enquirer): composable, plugin-based prompt system (Base is used in [prompt-base](https://github.com/enquirer/prompt-base), the core prompt module that powers all prompt plugins)
+* [enquirer](http://enquirer.io): composable, plugin-based prompt system (Base is used in [prompt-base](https://github.com/enquirer/prompt-base), the core prompt module that powers all prompt plugins)
 
@@ -554,2 +574,2 @@ **Lifecycle**
 
-_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.4.3, on April 02, 2017._
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on September 21, 2017._

No alert changes

Improved metrics

Total package byte prevSize

37285

increased by1.17%

Number of lines in readme file

563

increased by3.68%

Worsened metrics

Lines of code

398

decreased by-0.25%

Dependency changes

• + Addeddefine-property@1.0.0(transitive)

• + Addedis-descriptor@1.0.3(transitive)

• Updatedcache-base@^1.0.1

• Updateddefine-property@^1.0.0

• Updatedisobject@^3.0.1