Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/IonicaBizau/birthday

:birthday: Know when a friend's birthday is coming.
https://github.com/IonicaBizau/birthday

hacktoberfest

Last synced: 2 months ago
JSON representation

:birthday: Know when a friend's birthday is coming.

Host: GitHub
URL: https://github.com/IonicaBizau/birthday
Owner: IonicaBizau
License: mit
Created: 2015-06-02T18:47:37.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2020-08-09T09:58:13.000Z (about 4 years ago)
Last Synced: 2024-07-03T21:41:47.661Z (3 months ago)
Topics: hacktoberfest
Language: JavaScript
Homepage:
Size: 30.3 KB
Stars: 78
Watchers: 6
Forks: 8
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

awesome-cli-apps - birthday - Know when a friend's birthday is coming. (Productivity / Calendars)
fucking-awesome-cli-apps - birthday - Know when a friend's birthday is coming. (Productivity / Calendars)

README

        

[![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] [![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) [![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)



> Know when a friend's birthday is coming.

[![birthday](http://i.imgur.com/giMbOtY.png)](#)

## :cloud: Installation

You can install the package globally and use it as command line tool:

```sh

# Using npm

npm install --global birthday

# Using yarn

yarn global add birthday

```

Then, run `birthday --help` and see what the CLI tool can do.

```

$ birthday --help

Usage: birthday [options]

Options:

  -n, --name            The person name.

  -d, --date            The person birthday or born date.

  -c, --coming          Comming birthdays. Pass a date in the future.

  -b, --birthday-path   Use a different birthday json file path.

  -h, --help                  Displays this help.

  -v, --version               Displays version information.

Examples:

  birthday -n 'Ionică Bizău' -d '14/09/1995'

  birthday -n 'Ionică Bizău' -d '14/09'

  birthday -c '2015-10-10'

  birthday # displays all birthdays

Documentation can be found at https://github.com/IonicaBizau/birthday

```

## :clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use `npm install birthday` (or `yarn add birthday`):

```js

// Dependencies

var Birthday = require("birthday");

// Insert a new birthday

Birthday.insert({

    name: "Ionică Bizău"

  , born: new Date(1995, 9, 14)

});

```

## :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

For full API reference, see the [DOCUMENTATION.md][docs] file.

## :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:

## :scroll: License

[MIT][license] © [Ionică Bizău][website]

[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