update .verb.md and run verb to generate readme

helpers · Jun 26, 2018 · 22461fa · 22461fa
1 parent b8f2539
commit 22461fa
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 61 deletions.
diff --git a/.verb.md b/.verb.md
@@ -1,24 +1,16 @@
-# {%= name %} {%= badge("fury") %} {%= badge("travis") %}
-
-> {%= description %}
-
-Refactored to return an object, so the results of the helper can be passed to other helpers that require more information.
-
-{%= include("install-npm", {save: true}) %}
-
 ## Usage
 
 ```js
-var resolve = require('{%= name %}');
-var Handlebars = require('handlebars');
+const resolve = require('{%= name %}');
+const Handlebars = require('handlebars');
 
 handlebars.registerHelper('resolve', function (name, key) {
   return resolve.sync(fp)[typeof key === 'string' ? key : 'main'];
 });
-handlebars.compile('<script src=\"{{resolve "jquery" "main"}}\"></script>')().
+handlebars.compile('<script src=\"{{resolve "jquery" "main"}}\"></script>')();
 //=> '<script src="node_modules/jquery/dist/jquery.js"></script>'
 
-handlebars.compile('{{resolve "jquery" "homepage"}}')().
+handlebars.compile('{{resolve "jquery" "homepage"}}')();
 //=> 'http://jquery.com'
 ```
 
@@ -27,7 +19,7 @@ handlebars.compile('{{resolve "jquery" "homepage"}}')().
 Register the helper with [assemble] v0.6.x to use with any template engine:
 
 ```js
-var assemble = require('assemble');
+const assemble = require('assemble');
 assemble.helper('resolve', function (name, key) {
   return resolve.sync(fp)[typeof key === 'string' ? key : 'main'];
 });
@@ -46,23 +38,4 @@ assemble.asyncHelper('resolve', function (name, key, cb) {
     cb(null, res[key]);
   });
 });
-```
-
-## Run tests
-{%= include("tests") %}
-
-## Contributing
-{%= include("contributing") %}
-
-## Author
-{%= include("author") %}
-
-## License
-{%= copyright() %}
-{%= license() %}
-
-***
-
-{%= include("footer") %}
-
-[assemble]: https://github.com/assemble/assemble
+```
diff --git a/README.md b/README.md
@@ -1,37 +1,39 @@
-# helper-resolve [![NPM version](https://badge.fury.io/js/helper-resolve.svg)](http://badge.fury.io/js/helper-resolve)  [![Build Status](https://travis-ci.org/jonschlinkert/helper-resolve.svg)](https://travis-ci.org/jonschlinkert/helper-resolve) 
+# helper-resolve [![NPM version](https://img.shields.io/npm/v/helper-resolve.svg?style=flat)](https://www.npmjs.com/package/helper-resolve) [![NPM monthly downloads](https://img.shields.io/npm/dm/helper-resolve.svg?style=flat)](https://npmjs.org/package/helper-resolve)  [![NPM total downloads](https://img.shields.io/npm/dt/helper-resolve.svg?style=flat)](https://npmjs.org/package/helper-resolve) [![Linux Build Status](https://img.shields.io/travis/jonschlinkert/helper-resolve.svg?style=flat&label=Travis)](https://travis-ci.org/jonschlinkert/helper-resolve) [![Windows Build Status](https://img.shields.io/appveyor/ci/jonschlinkert/helper-resolve.svg?style=flat&label=AppVeyor)](https://ci.appveyor.com/project/jonschlinkert/helper-resolve)
 
-> Template helper to resolve the path to a file in node_modules. This is mostly useful during development.
+> Templates helper to resolve the path to a file in node_modules. This is mostly useful during development.
 
-Refactored to return an object, so the results of the helper can be passed to other helpers that require more information.
+Please consider following this project's author, [Jon Schlinkert](https://github.com/jonschlinkert), and consider starring the project to show your :heart: and support.
 
-## Install with [npm](npmjs.org)
+## Install
 
-```bash
-npm i helper-resolve --save
+Install with [npm](https://www.npmjs.com/):
+
+```sh
+$ npm install --save helper-resolve
 ```
 
 ## Usage
 
 ```js
-var resolve = require('helper-resolve');
-var Handlebars = require('handlebars');
+const resolve = require('helper-resolve');
+const Handlebars = require('handlebars');
 
 handlebars.registerHelper('resolve', function (name, key) {
   return resolve.sync(fp)[typeof key === 'string' ? key : 'main'];
 });
-handlebars.compile('<script src=\"{{resolve "jquery" "main"}}\"></script>')().
+handlebars.compile('<script src=\"{{resolve "jquery" "main"}}\"></script>')();
 //=> '<script src="node_modules/jquery/dist/jquery.js"></script>'
 
-handlebars.compile('{{resolve "jquery" "homepage"}}')().
+handlebars.compile('{{resolve "jquery" "homepage"}}')();
 //=> 'http://jquery.com'
 ```
 
 ## Assemble example
 
-Register the helper with [assemble] v0.6.x to use with any template engine:
+Register the helper with [assemble](https://github.com/assemble/assemble) v0.6.x to use with any template engine:
 
 ```js
-var assemble = require('assemble');
+const assemble = require('assemble');
 assemble.helper('resolve', function (name, key) {
   return resolve.sync(fp)[typeof key === 'string' ? key : 'main'];
 });
@@ -52,29 +54,42 @@ assemble.asyncHelper('resolve', function (name, key, cb) {
 });
 ```
 
-## Run tests
-Install dev dependencies:
+## About
+
+### Contributing
+
+Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).
+
+### Building docs
+
+_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
+
+To generate the readme, run the following command:
 
-```bash
-npm i -d && npm test
+```sh
+$ npm install -g verbose/verb#dev verb-generate-readme && verb
 ```
 
-## Contributing
-Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/jonschlinkert/helper-resolve/issues)
+### Running tests
 
-## Author
+Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
+
+```sh
+$ npm install && npm test
+```
+
+### Author
 
 **Jon Schlinkert**
 
-+ [github/jonschlinkert](https://github.com/jonschlinkert)
-+ [twitter/jonschlinkert](http://twitter.com/jonschlinkert) 
+* [github/jonschlinkert](https://github.com/jonschlinkert)
+* [twitter/jonschlinkert](https://twitter.com/jonschlinkert)
 
-## License
-Copyright (c) 2015 Jon Schlinkert  
-Released under the MIT license
+### License
 
-***
+Copyright © 2018, [Jon Schlinkert](https://github.com/jonschlinkert).
+Released under the [MIT License](LICENSE).
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on April 19, 2015._
+***
 
-[assemble]: https://github.com/assemble/assemble
+_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.7.0, on June 26, 2018._
diff --git a/package.json b/package.json
@@ -26,12 +26,35 @@
     "relative": "^3.0.2"
   },
   "devDependencies": {
+    "gulp-format-md": "^1.0.0",
     "handlebars": "^4.0.11",
     "jquery": "^3.3.1",
     "mocha": "^5.2.0"
   },
   "keywords": [
     "helper",
     "resolve"
-  ]
+  ],
+  "verb": {
+    "toc": false,
+    "layout": "common",
+    "tasks": [
+      "readme"
+    ],
+    "plugins": [
+      "gulp-format-md"
+    ],
+    "lint": {
+      "reflinks": true
+    },
+    "related": {
+      "list": []
+    },
+    "reflinks": [
+      "assemble",
+      "generate",
+      "generate-helper",
+      "helpers"
+    ]
+  }
 }