Updated docs

.gitignore

@@ -3,3 +3,7 @@
 *~
 *.log
 node_modules
+*.env
+.DS_Store
+package-lock.json
+.bloggify/*

DOCUMENTATION.md

@@ -6,6 +6,7 @@ You can see below the API reference of this module.
 Stringify metadata and content.
 
 #### Params
+
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
 - **Object** `[options]`: An object containing the following fields:
@@ -20,6 +21,7 @@ Stringify metadata and content.
 Parses the markdown input and the metadata.
 
 #### Params
+
 - **String** `input`: The markdown code. If it contains metadata, it will be parsed.
 - **Object** `[options]`: An object containing the following fields:
  - `start` (String): The metadata prefix (default: `---`).
@@ -34,6 +36,7 @@ Parses the markdown input and the metadata.
 Writes the generated content into a file.
 
 #### Params
+
 - **String** `path`: The file path.
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
@@ -44,6 +47,7 @@ Writes the generated content into a file.
 Parses a markdown file.
 
 #### Params
+
 - **String** `path`: The file path.
 - **Object** `[options]`: The parser options.
 - **Function** `[cb]`: The callback function.

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016-19 Ionică Bizău <[email protected]> (https://ionicabizau.net)
+Copyright (c) 2016-20 Ionică Bizău <[email protected]> (https://ionicabizau.net)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,3 +1,4 @@
+<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->
 
 
 
@@ -6,28 +7,56 @@
 
 
 
+[![mdify](http://i.imgur.com/koH6iq4.png)](#)
+
 
 
 
 
 
 
-![mdify](http://i.imgur.com/koH6iq4.png)
 
 
 
 
 # mdify
 
-Markdown helpers with metadata support.
+ [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Ask me anything](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/mdify.svg)](https://www.npmjs.com/package/mdify) [![Downloads](https://img.shields.io/npm/dt/mdify.svg)](https://www.npmjs.com/package/mdify) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)
+
+<a href="https://www.buymeacoffee.com/H96WwChMy" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/yellow_img.png" alt="Buy Me A Coffee"></a>
+
+
+
+
+
+
+
+> Markdown helpers with metadata support.
+
+
+
+
+
+
+
+
+
+
+
+
+
 
 
 
 
-## Installation
+## :cloud: Installation
 
 ```sh
-$ npm i mdify
+# Using npm
+npm install --save mdify
+
+# Using yarn
+yarn add mdify
 ```
 
 
@@ -38,16 +67,15 @@ $ npm i mdify
 
 
 
-## Example
 
 
 
 
+## :clipboard: Example
 
 
-```js
-"use strict";
 
+```js
 const mdify = require("mdify");
 
 let md = mdify.stringify({
@@ -77,24 +105,40 @@ console.log(mdify.parse(md));
 //      tags: [ 'hello', 'world' ] },
 //   rawMeta: '---\nauthor: Johnny B.\ndate: 2016-06-06T07:12:17.533Z\ntags:\n  - hello\n  - world',
 //   html: '<h2 id="helloworld">Hello World!</h2>\n\n<p>Hey <strong>there</strong>!</p>' }
-
 ```
 
 
 
 
 
 
-## Documentation
 
 
 
 
 
+## :question: Get Help
+
+There are few ways to get help:
+
+
+
+ 1. Please [post questions on Stack Overflow](https://stackoverflow.com/questions/ask). You can open issues with questions, as long you add a link to your Stack Overflow question.
+ 2. For bug reports and feature requests, open issues. :bug:
+ 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket:
+
+
+
+
+
+## :memo: Documentation
+
+
 ### `stringify(metadata, content, [options])`
 Stringify metadata and content.
 
 #### Params
+
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
 - **Object** `[options]`: An object containing the following fields:
@@ -109,6 +153,7 @@ Stringify metadata and content.
 Parses the markdown input and the metadata.
 
 #### Params
+
 - **String** `input`: The markdown code. If it contains metadata, it will be parsed.
 - **Object** `[options]`: An object containing the following fields:
  - `start` (String): The metadata prefix (default: `---`).
@@ -123,6 +168,7 @@ Parses the markdown input and the metadata.
 Writes the generated content into a file.
 
 #### Params
+
 - **String** `path`: The file path.
 - **Object** `metadata`: The metadata object.
 - **String** `content`: The markdown content.
@@ -133,6 +179,7 @@ Writes the generated content into a file.
 Parses a markdown file.
 
 #### Params
+
 - **String** `path`: The file path.
 - **Object** `[options]`: The parser options.
 - **Function** `[cb]`: The callback function.
@@ -147,15 +194,83 @@ An object containing the following fields:
 
 
 
-## How to contribute
+
+
+
+
+
+
+
+
+## :yum: How to contribute
 Have an idea? Found a bug? See [how to contribute][contributing].
 
 
+## :sparkling_heart: Support my projects
+I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously,
+this takes time. You can integrate and use these projects in your applications *for free*! You can even change the source code and redistribute (even resell it).
+
+However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:
+
+
+ - Starring and sharing the projects you like :rocket:
+ - [![Buy me a book][badge_amazon]][amazon]—I love books! I will remember you after years if you buy me one. :grin: :book:
+ - [![PayPal][badge_paypal]][paypal-donations]—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
+ - [![Support me on Patreon][badge_patreon]][patreon]—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
+ - **Bitcoin**—You can send me bitcoins at this address (or scanning the code below): `1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6`
+
+    ![](https://i.imgur.com/z6OQI95.png)
+
+
+Thanks! :heart:
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## :dizzy: Where is this library used?
+If you are using this library in one of your projects, add it in this list. :sparkles:
+
+ - `bloggify-markdown-adapter`
+
+
+
+
+
+
+
+
+
+
+
+## :scroll: License
+
+[MIT][license] © [Ionică Bizău][website]
+
+
+
 
-## License
-See the [LICENSE][license] file.
 
 
 [license]: /LICENSE
+[website]: https://ionicabizau.net
 [contributing]: /CONTRIBUTING.md
 [docs]: /DOCUMENTATION.md
+[badge_patreon]: https://ionicabizau.github.io/badges/patreon.svg
+[badge_amazon]: https://ionicabizau.github.io/badges/amazon.svg
+[badge_paypal]: https://ionicabizau.github.io/badges/paypal.svg
+[badge_paypal_donate]: https://ionicabizau.github.io/badges/paypal_donate.svg
+[patreon]: https://www.patreon.com/ionicabizau
+[amazon]: http://amzn.eu/hRo9sIZ
+[paypal-donations]: https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=RVXDDLKKLQRJW

package.json

@@ -56,4 +56,4 @@
   "blah": {
     "h_img": "http://i.imgur.com/koH6iq4.png"
   }
-}
+}