From f6ba272eeb8329118cea2cb34fef234af6cd43fc Mon Sep 17 00:00:00 2001 From: Andinus Date: Thu, 19 Mar 2020 00:41:02 +0530 Subject: Add examples to readme --- README.org | 25 +++++++++++++++++++++++++ cmd/cetus/main.go | 2 +- 2 files changed, 26 insertions(+), 1 deletion(-) diff --git a/README.org b/README.org index 81d1de7..afe677c 100644 --- a/README.org +++ b/README.org @@ -38,3 +38,28 @@ demo videos someday. | v0.4.1 | https://diode.zone/videos/watch/a52cc728-93e5-4bba-9375-752e1dba306d | | v0.3.1 | https://diode.zone/videos/watch/0808c512-315a-4dab-9526-4a537e8c3257 | | v0.2.0 | https://diode.zone/videos/watch/12db31e1-3517-4888-ad06-55f3859447a1 | +* Examples +To learn about all supported flags run "cetus -help" +(example: cetus set apod -help) + +** cetus set +#+BEGIN_SRC sh +# set current apod as background +cetus set apod +cetus set nasa # same as above + +# set current bpod as background +cetus set bpod +cetus set bing # same as above + +# Currently all services support -random flag (v0.5.0) but this +# behaviour might change in future, run cetus set -help to +# know about support flags. + +# set random image as background +cetus set -random +#+END_SRC +** cetus fetch +#+BEGIN_SRC sh +cetus fetch +#+END_SRC diff --git a/cmd/cetus/main.go b/cmd/cetus/main.go index 08e7440..23ac6f4 100644 --- a/cmd/cetus/main.go +++ b/cmd/cetus/main.go @@ -114,7 +114,7 @@ func main() { } func printUsage() { - fmt.Println("Usage: cetus []\n") + fmt.Println("Usage: cetus []\n") fmt.Println("Commands: ") fmt.Println(" set Set the latest image as background") fmt.Println(" fetch Fetch the latest image information") -- cgit 1.4.1-2-gfad0