From f26480e0f758f3c4ac3cfa52bbb9eb9412e4aaaf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ionic=C4=83=20Biz=C4=83u?= Date: Thu, 7 Sep 2017 21:35:01 +0300 Subject: [PATCH] Updated docs --- .gitignore | 3 +++ DOCUMENTATION.md | 6 ++++++ README.md | 9 +++++++-- package.json | 2 +- 4 files changed, 17 insertions(+), 3 deletions(-) diff --git a/.gitignore b/.gitignore index 61f2900..af96bda 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,6 @@ *~ *.log node_modules +*.env +.DS_Store +package-lock.json diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index b762b75..d1c186f 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -6,6 +6,7 @@ You can see below the API reference of this module. Fetches birthday data. #### Params + - **Function** `callback`: The callback function. #### Return @@ -15,6 +16,7 @@ Fetches birthday data. Reads the JSON file. #### Params + - **Function** `callback`: The callback function. #### Return @@ -24,6 +26,7 @@ Reads the JSON file. Writes the JSON information in the file. #### Params + - **Object** `content`: The content as object. - **Function** `callback`: The callback function. @@ -34,6 +37,7 @@ Writes the JSON information in the file. Inserts a new birthday. #### Params + - **Object** `data`: An object which will be passed to the `Birthday.Event` constructor. - **Function** `callback`: The callback function. @@ -44,6 +48,7 @@ Inserts a new birthday. Find coming birthdays until the provided date. #### Params + - **Date|String** `d`: The date before you want to get the birthdays. - **Function** `callback`: The callback function. @@ -51,6 +56,7 @@ Find coming birthdays until the provided date. Sort the birthday dates. #### Params + - **Object** `obj`: An object containing the `birthdays` array. #### Return diff --git a/README.md b/README.md index 066acc2..d46e77e 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,11 @@ + + [![birthday](http://i.imgur.com/8jr9txD.png)](#) # `$ birthday` - [![Support me on Patreon][badge_patreon]][patreon] [![Buy me a book][badge_amazon]][amazon] [![PayPal][badge_paypal_donate]][paypal-donations] [![Travis](https://img.shields.io/travis/IonicaBizau/birthday.svg)](https://travis-ci.org/IonicaBizau/birthday/) [![Version](https://img.shields.io/npm/v/birthday.svg)](https://www.npmjs.com/package/birthday) [![Downloads](https://img.shields.io/npm/dt/birthday.svg)](https://www.npmjs.com/package/birthday) + [![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) [![Travis](https://img.shields.io/travis/IonicaBizau/birthday.svg)](https://travis-ci.org/IonicaBizau/birthday/) [![Version](https://img.shields.io/npm/v/birthday.svg)](https://www.npmjs.com/package/birthday) [![Downloads](https://img.shields.io/npm/dt/birthday.svg)](https://www.npmjs.com/package/birthday) > Know when a friend's birthday is coming. @@ -65,13 +67,15 @@ Birthday.insert({ }); ``` + + ## :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: + 3. For direct and quick help, you can [use Codementor](https://www.codementor.io/johnnyb). :rocket: ## :memo: Documentation @@ -90,6 +94,7 @@ this takes time. You can integrate and use these projects in your applications * 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` diff --git a/package.json b/package.json index 2110664..7f77189 100644 --- a/package.json +++ b/package.json @@ -57,4 +57,4 @@ "bloggify.json", "bloggify/" ] -} \ No newline at end of file +}