markdown-link - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

index.js

 'use strict';
 
-module.exports = mdlink;
-
 /**
+ * Create a markdown-formatted link from the given values.
+ *
  * ```js
- * mdlink('foo', 'https://github.com/bar/foo', 'baz');
- * //=> [foo](https://github.com/bar/foo "baz")
- *
- * mdlink('foo', 'https://github.com/bar/foo');
- * //=> [foo](https://github.com/bar/foo)
+ * mdlink('micromatch', 'https://github.com/jonschlinkert/micromatch', 'hover title');
+ * //=> [micromatch](https://github.com/jonschlinkert/micromatch "hover title")
  * ```
  *
+ * @name link
  * @param  {String} `anchor`
@@ -20,4 +18,3 @@ * @param  {String} `href`
 
-
-function mdlink(anchor, href, title) {
+module.exports = function link(anchor, href, title) {
   if (typeof anchor !== 'string') {
@@ -24,0 +21,0 @@ throw new TypeError('markdown-link expects anchor to be a string.');

package.json

 {
   "name": "markdown-link",
   "description": "Micro util for generating a single markdown link.",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "homepage": "https://github.com/jonschlinkert/markdown-link",
@@ -6,0 +6,0 @@ "author": {

README.md

@@ -15,15 +15,23 @@ # markdown-link [![NPM version](https://badge.fury.io/js/markdown-link.svg)](http://badge.fury.io/js/markdown-link)
 var mdlink = require('markdown-link');
+```
 
-mdlink('abc', 'https://github.com/xyz/abc');
-//=> [abc](https://github.com/xyz/abc)
+## Usage
+### [.link](./index.js#L18)
 
-mdlink('abc', 'https://github.com/xyz/abc', 'Title text.');
-//=> [abc](https://github.com/xyz/abc "Title text.")
+Create a markdown-formatted link from the given values.
+
+* `anchor` **{String}**    
+* `href` **{String}**    
+* `title` **{String}**    
+
+```js
+mdlink('micromatch', 'https://github.com/jonschlinkert/micromatch', 'hover title');
+//=> [micromatch](https://github.com/jonschlinkert/micromatch "hover title")
 ```
 
 ## Related projects
+* [remarkable](https://github.com/jonschlinkert/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
+* [markdown-toc](https://github.com/jonschlinkert/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable.
 * [markdown-utils](https://github.com/jonschlinkert/markdown-utils): Micro-utils for creating markdown snippets.
-* [gfm-code-blocks](https://github.com/jonschlinkert/gfm-code-blocks): Extract gfm (GitHub Flavored Markdown) fenced code blocks from a string.
-* [remarkable](https://github.com/jonschlinkert/remarkable): Markdown parser, done right. 100% Commonmark support, extensions, syntax plugins, high speed - all in one.
-* [markdown-toc](https://github.com/jonschlinkert/markdown-toc): Generate a markdown TOC (table of contents) with Remarkable.  
+* [to-gfm-code-block](https://github.com/jonschlinkert/to-gfm-code-block): Generate a github-flavored-markdown fenced code block snippet.
 
@@ -53,2 +61,2 @@ ## Running tests
 
-_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 14, 2015._
+_This file was generated by [verb-cli](https://github.com/assemble/verb-cli) on March 20, 2015._

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

4474

increased by4.12%

Number of lines in readme file

60

increased by15.38%

Worsened metrics

Lines of code

25

decreased by-3.85%

No dependency changes