README.md in birthdays-0.1.2 vs README.md in birthdays-0.1.3
- old
+ new
@@ -1,11 +1,11 @@
# birthdays
* [Homepage](https://github.com/DamienRobert/birthdays#readme)
* [Issues](https://github.com/DamienRobert/birthdays/issues)
* [Documentation](http://rubydoc.info/gems/birthdays)
-* [Email](mailto:Damien.Olivier.Robert+gems at gmail.com)
+* [Email](mailto:Damien.Olivier.Robert+gems@gmail.com)
[](https://rubygems.org/gems/birthdays)
[](https://travis-ci.org/DamienRobert/birthdays)
## Description
@@ -26,20 +26,46 @@
"New Year": "01 January"
"John Doe": 1970-01-01
Then to see the birthdays for next week just use
- birthdays 'now..in 7 days'
+ $ birthdays 'now..in 7 days'
-## Install
+By default it uses the current day. We can also specify several ranges:
- $ gem install birthdays
+ $ birthdays '2020-01-01'
+ On 2020-01-01 12:00:00 +0100, the birthdays are
+ - New Year (born 2021-01-01, -1y)
+ - John Doe (born 1970-01-01, 50y)
-## Synopsis
+ $ birthdays '2020-01-01..2020-02-01' '2020-06-01..2020-08'
+ On (2020-01-01 12:00:00 +0100..2020-02-01 12:00:00 +0100), the birthdays are
+ - New Year (born 2021-01-01, -1y)
+ - John Doe (born 1970-01-01, 50y)
+ On (2020-06-01 12:00:00 +0200..2020-08-16 12:00:00 +0200), the birthdays are
+ - Father's Day (born 2021-06-20, -1y)
- $ birthdays time..period
+Or query for the age instead:
+ $ birthdays --age 2020-01-01 2030-01
+ On 2020-01-01 12:00:00 +0100, the ages are
+ - Father's Day (born 2021-06-20, -2y) [-46177200 secs]
+ - Christmas (born 2020-12-25, -1y) [-30888000 secs]
+ - New Year (born 2021-01-01, -1y) [-31492800 secs]
+ - John Doe (born 1970-01-01, 50y) [50 yrs 1 day]
+ On 2030-01-16 12:00:00 +0100, the ages are
+ - Father's Day (born 2021-06-20, 9y) [104 mos 12 days 13 hrs]
+ - Christmas (born 2020-12-25, 10y) [110 mos 9 days 12 hrs]
+ - New Year (born 2021-01-01, 9y) [110 mos 2 days 12 hrs]
+ - John Doe (born 1970-01-01, 60y) [731 mos 12 hrs]
+
+## Install
+
+ ~~~ sh
+ $ gem install birthdays
+ ~~~
+
## Copyright
-Copyright © 2015–2017 Damien Robert
+Copyright © 2015–2020 Damien Robert
-MIT License. See [LICENSE.txt](./LICENSE.txt) for details.
+MIT License. See [`LICENSE.txt`](LICENSE.txt) for details.