From ac1b8f399f2789645dd4eae2d79ffc7bd00bed77 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Wed, 30 Aug 2017 10:13:22 +0300 Subject: [PATCH] Updated docs --- DOCUMENTATION.md | 6 ++++++ README.md | 38 +++++++++++++++++++++++++++++++++----- 2 files changed, 39 insertions(+), 5 deletions(-) diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 762a8be..163b01e 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -2,6 +2,12 @@ You can see below the API reference of this module. +### `bloggify:init(config)` + +#### Params +- **Object** `config`: + - `key` (String): The Sendgrid API key. + ### `send(data, cb)` Send an email. diff --git a/README.md b/README.md index 308a6d1..ee456ba 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # bloggify-sendgrid - [![Patreon](https://img.shields.io/badge/Support%20me%20on-Patreon-%23e6461a.svg)][patreon] [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![AMA](https://img.shields.io/badge/ask%20me-anything-1abc9c.svg)](https://github.com/IonicaBizau/ama) [![Version](https://img.shields.io/npm/v/bloggify-sendgrid.svg)](https://www.npmjs.com/package/bloggify-sendgrid) [![Downloads](https://img.shields.io/npm/dt/bloggify-sendgrid.svg)](https://www.npmjs.com/package/bloggify-sendgrid) [![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) + [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Version](https://img.shields.io/npm/v/bloggify-sendgrid.svg)](https://www.npmjs.com/package/bloggify-sendgrid) [![Downloads](https://img.shields.io/npm/dt/bloggify-sendgrid.svg)](https://www.npmjs.com/package/bloggify-sendgrid) > Bloggify plugin for sending emails via SendGrid. @@ -32,9 +32,24 @@ Email.send({ }); ``` +## :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 from me, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: + + ## :memo: Documentation +### `bloggify:init(config)` + +#### Params +- **Object** `config`: + - `key` (String): The Sendgrid API key. + ### `send(data, cb)` Send an email. @@ -59,21 +74,34 @@ In the Bloggify config you will have to provide the following data: Have an idea? Found a bug? See [how to contribute][contributing]. -## :moneybag: Donations +## :sparkling_heart: Support my projects + +I open-source almost everything I can, and I try to reply 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). -Another way to support the development of my open-source modules is -to [set up a recurring donation, via Patreon][patreon]. :rocket: +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: -[PayPal donations][paypal-donations] are appreciated too! Each dollar helps. + - Starring and sharing the projects you like :rocket: + - [![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: + ## :scroll: License [MIT][license] © [Ionică Bizău][website] +[badge_patreon]: http://ionicabizau.github.io/badges/patreon.svg +[badge_amazon]: http://ionicabizau.github.io/badges/amazon.svg +[badge_paypal]: http://ionicabizau.github.io/badges/paypal.svg +[badge_paypal_donate]: http://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 [donate-now]: http://i.imgur.com/6cMbHOC.png