README.md in friends-0.54 vs README.md in friends-0.55
- old
+ new
@@ -1,8 +1,8 @@
[](https://badge.fury.io/rb/friends)
[](https://codecov.io/gh/JacobEvelyn/friends)
-[](https://travis-ci.com/JacobEvelyn/friends)
+[](https://github.com/JacobEvelyn/friends/actions?query=workflow%3AMain)
[](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 valuable, please consider
@@ -30,26 +30,23 @@
- [Syncing across multiple machines](#syncing-across-multiple-machines)
- [Setting reminders](#setting-reminders)
- [Command reference](#command-reference)
- `add`
- [`add activity`](#add-activity)
+ - [Setting a default location](#setting-a-default-location)
- [`add note`](#add-note)
- [`add friend`](#add-friend)
- [`add tag`](#add-tag)
- [`add location`](#add-location)
- [`add nickname`](#add-nickname)
- [`add alias`](#add-alias)
- - [Adding a default location](#adding-a-default-location)
- [`clean`](#clean)
- [`graph`](#graph)
- [`help`](#help)
- `list`
- [`list activities`](#list-activities)
- [`list notes`](#list-notes)
- - `list favorite`
- - [`list favorite friends`](#list-favorite-friends)
- - [`list favorite locations`](#list-favorite-locations)
- [`list friends`](#list-friends)
- [`list tags`](#list-tags)
- [`list locations`](#list-locations)
- [Advanced searching](#advanced-searching)
- `remove`
@@ -352,10 +349,31 @@
This is really handy for when you have an activity involving a friend or location that
you can't remember if you've already added. Just use the signifiers and
they'll be added if necessary!
+##### Setting a default location
+
+When an activity includes the phrase to \_LOCATION\_ (e.g., Took a plane to \_Paris\_), all future activities that have no explicit location will be associated with that location:
+
+```bash
+$ friends add activity Took a plane to Paris
+Activity added: "2020-01-04: Took a plane to Paris"
+Default location set to: "Paris"
+$ friends add activity Ate lunch at a charming café
+Activity added: "2020-01-04: Ate lunch at a charming café"
+$ friends add activity Left the city to go to Chamonix
+Activity added: "2020-01-04: Left the city to go to Chamonix"
+Default location set to: "Chamonix"
+```
+
+```bash
+$ friends list activities --in Paris
+2019-01-04: Ate lunch at a charming café
+2019-01-04: Took a plane to Paris
+```
+
#### `add note`
Notes can be added exactly like activities, either on one line:
```bash
@@ -408,45 +426,24 @@
#### `add nickname`
```bash
$ friends add nickname "Grace Hopper" "The Admiral"
-Nickname added: "Grace Hopper (a.k.a. The Admiral)
+Nickname added: "Grace Hopper (a.k.a. The Admiral)"
$ friends add nickname "Grace Hopper" "Amazing Grace"
Nickname added: "Grace Hopper (a.k.a. The Admiral a.k.a. Amazing Grace)"
```
#### `add alias`
```bash
$ friends add alias "New York City" "NYC"
-Alias added: "New York City (a.k.a. NYC)
+Alias added: "New York City (a.k.a. NYC)"
$ friends add alias "New York City" "Big Apple"
Alias added: "New York City (a.k.a. NYC a.k.a. Big Apple)"
```
-#### Setting a default location
-
-When an activity includes the phrase to \_LOCATION\_ (e.g., Took a plane to \_Paris\_), all future activities that have no explicit location will be associated with that location:
-
-```bash
-$ friends add activity Took a plane to Paris
-Activity added: "2020-01-04: Took a plane to Paris"
-Default location set to: "Paris"
-$ friends add activity Ate lunch at a charming café
-Activity added: "2020-01-04: Ate lunch at a charming café"
-$ friends add activity Left the city to go to Chamonix
-Activity added: "2020-01-04: Left the city to go to Chamonix"
-Default location set to: "Chamonix"
-```
-
-```bash
-$ friends list activities --in Paris
-2019-01-04: Ate lunch at a charming café
-2019-01-04: Took a plane to Paris
-```
-
#### `clean`
Reads and re-writes the `friends.md` file:
```bash
@@ -709,43 +706,46 @@
$ friends list notes --tagged school --with Marie
2017-03-12: Marie Curie completed her PhD in record time. @school
2015-06-06: Marie Curie just got accepted into a PhD program in Paris. @school
```
-#### `list favorite friends`
+#### `list friends`
-Lists your "favorite" friends (by total number of activities):
+Lists all of your friends in alphabetical order:
```bash
-$ friends list favorite friends
-Your favorite friends:
-1. George Washington Carver (2 activities)
-2. Grace Hopper (1)
-3. Marie Curie (0)
+$ friends list friends
+George Washington Carver
+Grace Hopper
+Marie Curie
```
-#### `list favorite locations`
+Or you can choose to sort by number of activities:
-Lists your "favorite" locations (by total number of activities):
-
```bash
-$ friends list favorite locations
-Your favorite locations:
-1. Atlantis (2 activities)
-2. Paris (1)
-3. London (0)
+$ friends list friends --sort n-activities
+2 activities: George Washington Carver
+2 activities: Grace Hopper
+1 activity: Marie Curie
```
-#### `list friends`
+Or by most recent activity:
-Lists all of your friends in alphabetical order:
+```bash
+$ friends list friends --sort recency
+7 days ago: Grace Hopper
+308 days ago: George Washington Carver
+312 days ago: Marie Curie
+```
+And you can reverse the sorting at any time:
+
```bash
-$ friends list friends
-George Washington Carver
-Grace Hopper
-Marie Curie
+$ friends list friends --sort n-activities --reverse
+1 activity: Marie Curie
+2 activities: Grace Hopper
+2 activities: George Washington Carver
```
You can also include friend nicknames, locations, and tags:
```bash
@@ -831,9 +831,45 @@
```
$ friends list locations
Atlantis
New York City
+Paris
+```
+
+Or you can choose to sort by number of activities:
+
+```bash
+$ friends list locations --sort n-activities
+1 activity: New York City
+1 activity: Paris
+0 activities: Atlantis
+```
+
+Or by most recent activity:
+
+```bash
+$ friends list locations --sort recency
+N/A days ago: Atlantis
+7 days ago: New York City
+312 days ago: Paris
+```
+
+And you can reverse the sorting at any time:
+
+```bash
+$ friends list friends --sort n-activities --reverse
+0 activities: Atlantis
+1 activity: Paris
+1 activity: New York City
+```
+
+You can also include location aliases:
+
+```bash
+$ friends list locations --verbose
+Atlantis
+New York City (a.k.a. NYC)
Paris
```
#### Advanced searching