]> git.seodisparate.com - mpd_info_screen/commitdiff
Update README.md with usage
authorStephen Seo <seo.disparate@gmail.com>
Thu, 16 Sep 2021 07:08:29 +0000 (16:08 +0900)
committerStephen Seo <seo.disparate@gmail.com>
Thu, 16 Sep 2021 07:08:29 +0000 (16:08 +0900)
README.md

index 773112436afb4176d478973a4807e5ecf83933fe..b9c61668e857439ef2572c1c6e40402ed5b5f21b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -5,6 +5,24 @@ A Rust program that displays info about the currently running MPD server.
 The window shows albumart (embedded in the audio file), a "time-remaining"
 counter, and the filename currently being played
 
+# Usage
+
+    mpd_info_screen 0.1.0
+    
+    USAGE:
+        mpd_info_screen [OPTIONS] <host> [port]
+    
+    FLAGS:
+        -h, --help       Prints help information
+        -V, --version    Prints version information
+    
+    OPTIONS:
+        -p <password>        
+    
+    ARGS:
+        <host>    
+        <port>     [default: 6600]
+
 # Issues / TODO
 
 [ ] UTF-8 Non-ascii font support