--- a/README.md Mon May 08 21:10:28 2017 +0200
+++ b/README.md Mon May 08 21:39:55 2017 +0200
@@ -40,7 +40,7 @@
These settings can be passed as command line arguments or environment variables,
but the easiest way is to use a configuration file.
-Note that you can generate a configuration file for your settings with
+Note that you can *generate a configuration file* for your settings with
`madonctl config dump -i mastodon.social -L username@domain -P password`
@@ -82,7 +82,7 @@
% echo "Hello from #madonctl" | madonctl toot --stdin
```
-Some account-related commands:
+Some *account-related commands*:
``` sh
% madonctl accounts blocked # List blocked accounts
% madonctl accounts muted # List muted accounts
@@ -109,15 +109,8 @@
``` sh
% madonctl accounts statuses # See last posts
% madonctl accounts statuses --all # See all statuses
-% madonctl accounts --user-id Gargron@mastodon.social -l5 # Last 5 statuses
```
-You can specify the (instance-specific) account ID number (--account-id) or
-the user ID (--user-id). In the later case, madonctl will search for the
-user so it must match exactly the ID known to your instance (without the
-@domain suffix if the user is on the same instance). With madonctl v0.6.1+,
-the --user-id flag can also contain an HTTP account URL.
-
Display accounts you're following or your followers:
``` sh
% madonctl accounts following # See last following
@@ -125,7 +118,7 @@
% madonctl accounts followers --limit 30 # Last 30 followers
```
-Add/remove a favourite, boost a status...
+Add/remove a *favourite*, *boost* a status...
``` sh
% madonctl status --status-id 416671 favourite # Fave a status
% madonctl status --status-id 416671 boost # Boost a status
@@ -136,7 +129,7 @@
% madonctl accounts search gargron
```
-Follow an account with known ID:
+*Follow* an account with known ID:
``` sh
% madonctl accounts follow --account-id 1234
```
@@ -146,7 +139,24 @@
% madonctl accounts follow --remote Gargron@mastodon.social
```
-Read timelines:
+*Search* for accounts, statuses or hashtags:
+``` sh
+% madonctl search gargron
+% madonctl search mastodon
+```
+
+When the account ID is unknown, --user-id can be useful.\
+You can specify the (instance-specific) account ID number (--account-id) or
+the user ID (--user-id). In the later case, madonctl will search for the
+user so it must match exactly the ID known to your instance (without the
+@domain suffix if the user is on the same instance). With madonctl v0.6.1+,
+the --user-id flag can also contain an HTTP account URL.
+``` sh
+% madonctl accounts --user-id Gargron@mastodon.social -l5 # Last 5 statuses
+% madonctl accounts --user-id https://mastodon.social/@Gargron -l5 # Same
+```
+
+Read *timelines*:
``` sh
% madonctl timeline # Display home timeline
% madonctl timeline public # Display federated timeline
@@ -155,14 +165,14 @@
% madonctl timeline --limit 3 # Display 3 latest home timeline messages
```
-Use the streaming API and fetch timelines and notifications:
+Use the *streaming API* and fetch timelines and notifications:
``` sh
% madonctl stream # Stream home timeline and notifications
% madonctl stream local # Stream local timeline
% madonctl stream public # Stream federated timeline
```
-You can also use hashtag streams:
+You can also use *hashtag streams*:
``` sh
% madonctl stream :mastodon # Stream for hastag 'mastodon'
% madonctl stream :madonctl,golang # Stream for several hashtags
@@ -172,7 +182,7 @@
concurrent hashtags is currently limited to 4 for "politeness".
-(Almost) All commands have a customisable output:
+(Almost) All commands have a *customisable output*:
``` sh
% madonctl accounts show # Display an account
% madonctl accounts show -o yaml # Display an account, in yaml
@@ -180,7 +190,7 @@
% madonctl stream local -o json # Stream local timeline and output to JSON
```
-You can also use Go (Golang) templates:
+You can also use Go (Golang) *templates*:
``` sh
% madonctl accounts --account-id 1 followers --template '{{.acct}}{{"\n"}}'
```
@@ -200,7 +210,7 @@
### Shell completion
-If you want shell completion, you can generate scripts with the following command: \
+If you want *shell completion*, you can generate scripts with the following command: \
`madonctl completion bash` (or zsh)
Then, just source the script in your shell.
@@ -211,7 +221,7 @@
### Commands output
-The output can be set to json, yaml or to a Go template for all commands.\
+The output can be set to *json*, *yaml* or to a *Go template* for all commands.\
If you are familiar with Kubernetes' kubectl, it is very similar.
For example, you can display your user token with:\
@@ -222,8 +232,10 @@
All the users that have favorited a given status:\
`madonctl status --status-id 101194 favourited-by --template '{{.username}}{{"\n"}}'`
+Sets of templates can be grouped as *themes*.
+
For more complex templates, one can use the `--template-file` option.\
-See the [templates](templates) folder.
+See the [themes & templates](templates) folder.
## References