aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorNathan Jaremko2019-02-24 19:09:44 -0500
committerNathan Jaremko2019-02-24 19:09:44 -0500
commitd95e6b945b706db0b149b8af580f6cd8484e527b (patch)
tree0f9a0332a981aa5d3e1f38d2d8becf897e3de894 /README.md
parentf25fc04521e49e51c773b9f6e6bc03175e164fe6 (diff)
downloadpodcast-d95e6b945b706db0b149b8af580f6cd8484e527b.tar.bz2
Add completion info to README
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 1928ea8..0915094 100644
--- a/README.md
+++ b/README.md
@@ -37,7 +37,7 @@ All: `podcast download $podcast_name`
You can also use a portion of the name.
Podcast will pick the first podcast alphabetically that contains the given word (Case-Insensitive).
-Example Usage:
+# Example Usage:
```sh
$ podcast subscribe "http://feeds.feedburner.com/mbmbam"
$ podcast ls
@@ -60,3 +60,14 @@ Downloading: /home/njaremko/Podcasts/My Brother, My Brother And Me/MBMBaM 244: S
Downloading: /home/njaremko/Podcasts/My Brother, My Brother And Me/MBMBaM 144: Kick it Forward.mp3
Downloading: /home/njaremko/Podcasts/My Brother, My Brother And Me/My Brother, My Brother and Me 44: Chunk Pump.mp3
```
+
+# Generating completions:
+```sh
+# Generating completion for current shell:
+$ podcast completion
+... outputs stuff that needs to be loaded by your shell on startup ...
+
+# Fish Shell Example
+$ podcast completion fish > podcast.fish
+$ sudo mv podcast.fish /usr/share/fish/completions
+``` \ No newline at end of file