README.md in friends-0.36 vs README.md in friends-0.37
- old
+ new
@@ -5,26 +5,30 @@
[](http://clayallsopp.github.io/readme-score?url=JacobEvelyn/friends)
[](http://inch-ci.org/github/JacobEvelyn/friends)
[](https://rubygems.org/gems/friends)
`friends` is a volunteer project. If you find it useful, please consider
-making a small donation to show me you appreciate its continued development.
+making a small donation (🙏) to show you appreciate its continued development.
-[](https://opencollective.com/friends)
+👇 Donate with these buttons! 👇
+
+[/badge.svg>)](#backers) [/badge.svg>)](#sponsors)
[](https://www.patreon.com/jacobevelyn)
[](https://liberapay.com/jacobevelyn/donate)
[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
[](https://flattr.com/submit/auto?user_id=jacobevelyn&url=https://github.com/JacobEvelyn/friends&title=friends&tags=github&category=software)
[](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)
+👆 Donate with these buttons! 👆
+
# `friends`
Spend time with the people you care about. Introvert-tested.
Extrovert-approved.
-**NOTE: Participation is encouraged! Make Issues, ask questions, submit Pull
-Requests (even if it's your first time contributing to open-source—you'll get
+**NOTE: Participation is encouraged! Make issues, ask questions, submit pull
+requests (even if it's your first time contributing to open-source—you'll get
lots of help), and give feedback!**
## Table of Contents
* [Overview](#overview)
@@ -116,11 +120,11 @@
* **Friends**: The people you do _activities_ with. Each friend has a name and,
optionally, one or several nicknames. (Examples: `John`, `Grace Hopper`)
* **Locations**: The places in which _activities_ happen. (Examples: `Paris`,
`Marie's Diner`)
* **Tags**: A way to categorize your _activities_ with tags of your
- choosing. (Examples: `@exercise`, `@school`)
+ choosing. Tags may contain colons and hyphens inside them. (Examples: `@exercise:running`, `@school`, `@science:indoors:agronomy-with-hydroponics`)
* **Notes**: Any additional information you want to record about a _friend_
or _location_. (Example: `John and Jane got engaged.`)
The `friends.md` Markdown file that stores all of your data contains:
@@ -280,12 +284,12 @@
Tags will be colored if they're provided (though this README can't display
color so you'll just have to have faith here):
```bash
-$ friends add activity The office softball team wins a game! @work @exercise
-Activity added: "2017-05-05: The office softball team wins a game! @work @exercise"
+$ friends add activity The office softball team wins a game! @work @exercise:sports
+Activity added: "2017-05-05: The office softball team wins a game! @work @exercise:sports"
```
You can of course specify a date for the activity:
```bash
@@ -573,20 +577,20 @@
Lists recent activities:
```bash
$ friends list activities
2018-01-04: Got lunch with Grace Hopper and George Washington Carver. @food
-2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying
+2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying:ball-drop
2017-11-15: Talked to George Washington Carver on the phone for an hour.
```
You can adjust how many activities are shown:
```bash
$ friends list activities --limit 2
2018-01-04: Got lunch with Grace Hopper and George Washington Carver. @food
-2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying
+2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying:ball-drop
```
Or only list the activities you did with a certain friend:
```bash
@@ -604,11 +608,11 @@
Or filter your activities by location:
```bash
$ friends list activities --in "New York"
-2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying
+2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying:ball-drop
```
Or by tag:
```bash
@@ -626,16 +630,16 @@
Or by date:
```bash
$ friends list activities --since 'December 31st 2017'
2018-01-04: Got lunch with Grace Hopper and George Washington Carver. @food
-2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying
+2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying:ball-drop
```
```bash
$ friends list activities --until 'December 31st 2017'
-2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying
+2017-12-31: Celebrated the new year with Marie Curie in New York City. @partying:ball-drop
2017-11-15: Talked to George Washington Carver on the phone for an hour.
```
And you can mix and match these options to your heart's content:
@@ -925,19 +929,50 @@
[RubyDoc](http://www.rubydoc.info/github/JacobEvelyn/friends).
## Contributing (it's encouraged!)
If you have an idea,
-[make a GitHub Issue](https://github.com/JacobEvelyn/friends/issues/new)!
+[make a GitHub issue](https://github.com/JacobEvelyn/friends/issues/new)!
Suggestions are very very welcome, and usually are implemented very
quickly. And if you'd like to do the implementing yourself, see the
[contributing guide](https://github.com/JacobEvelyn/friends/blob/master/CONTRIBUTING.md).
A big big thanks to all of this project's lovely
-[contributors](https://github.com/JacobEvelyn/friends/graphs/contributors)!
+[contributors](https://github.com/JacobEvelyn/friends/graphs/contributors):
-Another way to contribute is to make a donation (see the buttons at the top
-of this `README`)!
+<a href="https://github.com/JacobEvelyn/friends/graphs/contributors"><img src="https://opencollective.com/friends/contributors.svg?width=890" /></a>
+
+Another way to contribute is to make a donation with any of these buttons:
+
+[/badge.svg>)](https://opencollective.com/friends#backer) [/badge.svg>)](https://opencollective.com/friends#sponsor)
+[](https://www.patreon.com/jacobevelyn)
+[](https://liberapay.com/jacobevelyn/donate)
+[](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=jacobevelyn%40gmail%2ecom&lc=US&item_name=Development%20of%20JacobEvelyn%2ffriends%20%28GitHub%20repository%29&no_note=0¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_SM%2egif%3aNonHostedGuest)
+[](https://flattr.com/submit/auto?user_id=jacobevelyn&url=https://github.com/JacobEvelyn/friends&title=friends&tags=github&category=software)
+[](https://nrobinson2000.github.io/donate-bitcoin?address=1CFu6gWpmS89EnitPPdYssZhFMRWx5qhW4&amount=10&name=support-friends-development)
+
+👆 Donate with these buttons right here! 👆
+
+### Backers
+
+Thank you to all backers! 🙏 [[Become a backer](https://opencollective.com/friends#backer)]
+
+<a href="https://opencollective.com/friends#backers" target="_blank"><img src="https://opencollective.com/friends/backers.svg?width=890"></a>
+
+### Sponsors
+
+Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/friends#sponsor)]
+
+<a href="https://opencollective.com/friends/sponsor/0/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/0/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/1/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/1/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/2/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/2/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/3/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/3/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/4/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/4/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/5/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/5/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/6/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/6/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/7/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/7/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/8/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/8/avatar.svg"></a>
+<a href="https://opencollective.com/friends/sponsor/9/website" target="_blank"><img src="https://opencollective.com/friends/sponsor/9/avatar.svg"></a>
## Code of Conduct
Note that this project follows a [Code of Conduct](https://github.com/JacobEvelyn/friends/blob/master/CODE_OF_CONDUCT.md).
If you're a polite, reasonable person you won't have any issues!