habitica-markdown - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "habitica-markdown",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A markdown-it module pre-configured for use in Habitica",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

 # habitica-markdown
 A markdown-it module pre-configured for use in Habitica
+
+## Usage
+
+```bash
+npm install habitica-markdown --save
+bower install habitica-markdown --save
+```
+
+In Node with browserify/webpack/etc:
+
+```js
+var md = require('habitica-markdowm');
+md.render('_markdown_ is **awesome**');
+```
+
+In a browser with script tag
+
+```
+var md = window.habiticaMarkdown;
+md.render('_markdown_ is **awesome**');
+```
+
+## Pre-configured Settings and Plugins
+
+Habitica Markdown comes pre-configured with
+
+* Raw urls get converted to links with the [linkify setting set to true](https://github.com/markdown-it/markdown-it/#linkify)
+* Links open in new windows with [markdown-it-link-target](https://www.npmjs.com/package/markdown-it-link-target)
+* Images automatically turn into links with [markdown-it-linkify-images](https://www.npmjs.com/package/markdown-it-linkify-images)

No alert changes

Improved metrics

Total package byte prevSize

2766

increased by40.48%

Number of lines in readme file

32

increased by966.67%

No dependency changes