about summary refs log tree commit diff
diff options
context:
space:
mode:
authorManuel Palenzuela <manuelpalenzuelamerino@gmail.com>2019-06-30 12:52:28 +0200
committerManuel Palenzuela <manuelpalenzuelamerino@gmail.com>2019-06-30 12:52:28 +0200
commit073af5fec35d17ffd0ac33944c01e812cf908f15 (patch)
treeb25e45113470889bf8cb09c0e8bceb4045a5ad4b
parentAdded readme file (diff)
downloadsmart-wallpaper-073af5fec35d17ffd0ac33944c01e812cf908f15.tar.gz
smart-wallpaper-073af5fec35d17ffd0ac33944c01e812cf908f15.tar.bz2
smart-wallpaper-073af5fec35d17ffd0ac33944c01e812cf908f15.zip
Added usage to readme
-rw-r--r--README.md22
-rwxr-xr-xsmart-wallpaper2
2 files changed, 10 insertions, 14 deletions
diff --git a/README.md b/README.md
index ead3d9b..6e23e75 100644
--- a/README.md
+++ b/README.md
@@ -16,22 +16,18 @@ Optional: gifsicle - animated wallpaper support
 
 ### Usage
 
-A step by step series of examples that tell you how to get a development env running
-
-Say what the step will be
-
+Usage: smart-wallpaper [FLAG]
+  Flags:
+    [-d]: NEEDED   : daytime wallpaper file/folder
+    [-n]: NEEDED   : nighttime wallpaper file/folder
+    [-l]: OPTIONAL : manual location (lat:long), if not added geoclue gets the location (requires internet)
+    [-h]: OPTIONAL : print help message
+
+Example:
 ```
-Give the example
+smart-wallpaper -d /home/user/Wallpapers/DayWallpaperFolder -n /home/user/Wallpapers/NightWallpaperFolder -l 0:0
 ```
 
-And repeat
-
-```
-until finished
-```
-
-End with an example of getting some data out of the system or using it for a little demo
-
 ## Contributing
 
 Feel free to submit pull requests to clean up the code/adding new features. Thank you!
diff --git a/smart-wallpaper b/smart-wallpaper
index 9c1650e..53f729b 100755
--- a/smart-wallpaper
+++ b/smart-wallpaper
@@ -22,7 +22,7 @@ print_usage() {
   echo "  Flags:"
   echo "    [-d]: NEEDED   : daytime wallpaper file/folder"
   echo "    [-n]: NEEDED   : nighttime wallpaper file/folder"
-  echo "    [-l]: OPTIONAL : manual location, if not added geoclue gets the location (requires internet)"
+  echo "    [-l]: OPTIONAL : manual location (lat:long), if not added geoclue gets the location (requires internet)"
   echo "    [-h]: OPTIONAL : print help message"
 }