Lusiadas
/
uc
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Abreu 2021-08-09 20:20:50 -03:00
parent 79b06bdc81
commit c3bd0cf99e
No known key found for this signature in database
GPG Key ID: 64835466FF55F7E1
1 changed files with 8 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -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)
<br/>
# 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.