From 073af5fec35d17ffd0ac33944c01e812cf908f15 Mon Sep 17 00:00:00 2001 From: Manuel Palenzuela Date: Sun, 30 Jun 2019 12:52:28 +0200 Subject: Added usage to readme --- README.md | 22 +++++++++------------- 1 file changed, 9 insertions(+), 13 deletions(-) (limited to 'README.md') 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! -- cgit 1.4.1