aboutsummaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2016-06-10 01:45:23 +1200
committerTom Ryder <tom@sanctum.geek.nz>2016-06-10 01:45:23 +1200
commit0145a09a9b4e26367fe07e207323baf516b5e95e (patch)
treebb1e2fb4c1dcb2915ed8e1d043731226a30e7ca5 /README.markdown
parentAdd sample .plzrc (diff)
downloadplz-0145a09a9b4e26367fe07e207323baf516b5e95e.tar.gz
plz-0145a09a9b4e26367fe07e207323baf516b5e95e.zip
Quick README
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown23
1 files changed, 23 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
new file mode 100644
index 0000000..f64f071
--- /dev/null
+++ b/README.markdown
@@ -0,0 +1,23 @@
+plz
+===
+
+Play a media file from a configured directory with a configured media player if
+it's a unique match for all the words given as arguments. If not unique, print
+all the matches to help the user pick unique terms.
+
+ $ plz led zep stairw
+ $ plz black sab iron m
+ $ plz beeth symph 9
+
+Create a file `/etc/plzrc` and/or `~/.plzrc` to use. A sample file is included
+as `plzrc.sample`.
+
+ dir=/path/to/media
+ player=mplayer
+
+Author
+: Tom Ryder <tom@sanctum.geek.nz>
+Copyright
+: 2016
+License
+: MIT