Commit e933b30b authored by Vildravn's avatar Vildravn
Browse files

Update readme

parent b7a9562c
# Today in WoW - Widget for Scriptable for iOS
![Today in WoW Widget screenshot](https://widgets.vildravn.dev/home/tiw.jpeg)
![Today in WoW Widget screenshot](home/tiw.jpeg)
Today in WoW parses the [Today in WoW section on wowhead.com](https://www.wowhead.com/#tiw-switcher-region) and displays the data as a configurable widget.
......@@ -12,13 +10,27 @@ The widget displays:
The individual elements can also be tapped for more information, leading either to a wowhead guide when tapping on the Calling quests and Torghast wings, the wowhead page of the tapped affix or the world boss' loot table. Tapping on an empty space on the widget brings up a map of current world quests for your region.
## Installation
### Installation
#### Cheerio
The Today in WoW widget is dependent on a module called Cheerio. You will need to install this module first, for the widget to work.
[![Download with ScriptDude](https://scriptdu.de/download.svg)](https://scriptdu.de/?name=cheerio&source=https%3A%2F%2Fgitlab.com%2Fvildravn%2Ftoday-in-wow-widget%2F-%2Fraw%2Fmaster%2Fcheerio.js&docs=https%3A%2F%2Fwidgets.vildravn.dev%2F%23tiw#generator)
or
Download Cheerio from [GitLab](https://gitlab.com/vildravn/today-in-wow-widget/-/raw/master/cheerio.js) and place it into the Scriptable folder on your iCloud Drive.
#### Today in WoW
After cheerio is installed in Scriptable, you can install the Today in WoW widget script.
[![Download with ScriptDude](https://scriptdu.de/download.svg)](https://scriptdu.de/?name=Today-in-WoW&source=https%3A%2F%2Fgitlab.com%2Fvildravn%2Ftoday-in-wow-widget%2F-%2Fraw%2Fmaster%2FToday%2520in%2520WoW.js&docs=https%3A%2F%2Fwidgets.vildravn.dev%2F%23tiw#generator)
or
Download the script from [GitLab](https://gitlab.com/vildravn/today-in-wow-widget/-/raw/master/Today%20in%20WoW.js) and place it into the Scriptable folder on your iCloud Drive.
Download Today in WoW from [GitLab](https://gitlab.com/vildravn/today-in-wow-widget/-/raw/master/Today%20in%20WoW.js) and place it into the Scriptable folder on your iCloud Drive.
After the script is installed within Scriptable:
1. Add a new Scriptable widget to your Home Screen (**Medium size only, for now**)
......@@ -29,4 +41,4 @@ After the script is installed within Scriptable:
1. Tap away from the Widget configuration modal
1. You may need to wait a bit for iOS to update the widget
[`Changelog`](https://gitlab.com/vildravn/today-in-wow-widget/-/blob/master/CHANGELOG.md)
[Changelog](https://gitlab.com/vildravn/today-in-wow-widget/-/blob/master/CHANGELOG.md)
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment