Skip to content
This repository has been archived by the owner on Jul 2, 2019. It is now read-only.

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
anupam-git committed Jun 22, 2018
1 parent e0a2817 commit 338263d
Showing 1 changed file with 17 additions and 12 deletions.
29 changes: 17 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,39 +10,44 @@ TODO
## Usage

```
Usage: paper [options]
Usage: ./paper [options]
Paper - A Random Wallpaper Application
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_path> 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 <widthxheight> Resolution of the wallpaper to be
downloaded
Default resolution : 1920x1080
Example : --resolution 1024x768
-r 1920x1080
Example : --resolution 1024x768
-r 1920x1080
-R, --refresh-rate <n[M|H]> 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 <comma seperated 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
Expand Down

0 comments on commit 338263d

Please sign in to comment.