Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Sep 7, 2017
1 parent c6cd38b commit f26480e
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 3 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,6 @@
*~
*.log
node_modules
*.env
.DS_Store
package-lock.json
6 changes: 6 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ You can see below the API reference of this module.
Fetches birthday data.

#### Params

- **Function** `callback`: The callback function.

#### Return
Expand All @@ -15,6 +16,7 @@ Fetches birthday data.
Reads the JSON file.

#### Params

- **Function** `callback`: The callback function.

#### Return
Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -44,13 +48,15 @@ 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.

### `sort(obj)`
Sort the birthday dates.

#### Params

- **Object** `obj`: An object containing the `birthdays` array.

#### Return
Expand Down
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
<!-- Please do not edit this file. Edit the `blah` field in the `package.json` instead. If in doubt, open an issue. -->


[![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.
Expand Down Expand Up @@ -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
Expand All @@ -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`
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,4 @@
"bloggify.json",
"bloggify/"
]
}
}

0 comments on commit f26480e

Please sign in to comment.