From c3bd0cf99e38790638248764ffca24e5531ad193 Mon Sep 17 00:00:00 2001 From: Abreu Date: Mon, 9 Aug 2021 20:20:50 -0300 Subject: [PATCH] Update README.md --- README.md | 24 ++++++++---------------- 1 file changed, 8 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index a8223ed..8e8b1f1 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,12 @@ -# uc - unsplash collections -> A plugin for [Oh My Fish](https://www.github.com/oh-my-fish/oh-my-fish). - [![GPL License](https://img.shields.io/badge/license-GPL-blue.svg?longCache=true&style=flat-square)](/LICENSE) [![Fish Shell Version](https://img.shields.io/badge/fish-v3.0.1-blue.svg?style=flat-square)](https://fishshell.com) [![Oh My Fish Framework](https://img.shields.io/badge/Oh%20My%20Fish-Framework-blue.svg?style=flat-square)](https://www.github.com/oh-my-fish/oh-my-fish) -
+# uc +> A plugin for [Oh My Fish](https://www.github.com/oh-my-fish/oh-my-fish) -## Description - -List photo collections on unsplash from where to get a wallpaper at random. +uc (unsplash collections) allows one to list photo collections on unsplash from where to draw a wallpaper at random. ## Options @@ -47,20 +43,16 @@ omf repositories add https://gitlab.com/argonautica/argonautica omf install uc ``` +### Dependencies + +This plugin uses [unsplash_wallpaper](https://github.com/cuth/unsplash-wallpaper) by [cuth](https://github.com/cuth) to get wallpapers. If you don't have it installed, you'll be prompted to install it upon installing of this plugin. + ## Configuration This script is optimized to work with environment variables available to [cron](https://en.wikipedia.org/wiki/Cron), so that you can change your background and lockscreen wallpapers periodically and automatically. As an example, to change them every 3 hours, use the command `crontab -e` and append the following line: ``` -0 */3 * * * fish -c uc +0 */3 * * * .local/share/omf/pkg/uc/functions/uc.fish ``` For more information on how to schedule tasks using cron, consult this [video](https://www.youtube.com/watch?v=8j0SWYNglcw). - -## Dependencies - -This plugin uses [unsplash_wallpaper](https://github.com/cuth/unsplash-wallpaper) by [cuth](https://github.com/cuth) to draw wallpapers. If you don't have it installed, you'll be prompted to install it upon the installation of this plugin. - ---- - -Ⓐ Made in Anarchy. No wage slaves were economically coerced into the making of this work.