diff --git a/README.md b/README.md index 392d924..1339a9f 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ TODO ## Usage ``` -Usage: paper [options] +Usage: ./paper [options] Paper - A Random Wallpaper Application A CLI Tool to set a random wallpaper from Unsplash.com @@ -18,31 +18,36 @@ A CLI Tool to set a random wallpaper from Unsplash.com Options: -d, --download Only download the wallpaper - -D, --dir Directory to download the wallpaper - Default dir : .cache/paper/ - Example : --dir ~/foo/bar - -D ~/foooo/baaaar + -D, --dir Directory to download the wallpaper + Default dir : .local/share/Paper/paper + Example : --dir ~/foo/bar + -D ~/foooo/baaaar -h, --help Displays this help -r, --resolution Resolution of the wallpaper to be downloaded Default resolution : 1920x1080 - Example : --resolution 1024x768 - -r 1920x1080 + Example : --resolution 1024x768 + -r 1920x1080 -R, --refresh-rate Refreshes Wallpaper every 'n' Minutes or 'n' Hours - Example : --refresh-rate 5M - -R 2H + Example : --refresh-rate 5M + -R 2H - -s, --save Save the provided configuration to file + -s, --save Save the [dir, resolution, tags] to file Will be used to remember user preference + -S, --start-daemon Start as daemon + To be used with --refresh-rate option + + -x, --stop-daemon Stop the daemon + -t, --tags Provide tags to filter wallpaper search results - Example : --tags nature - -t water,mountain + Example : --tags nature + -t water,mountain -v, --version Displays version information