Skip to content

Commit 294df17

Browse files
authored
Updated README.md
1 parent 6ff29cc commit 294df17

File tree

1 file changed

+21
-8
lines changed

1 file changed

+21
-8
lines changed

README.md

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,29 +5,42 @@ This is a simple widget that allows you to add your favorite news site via RSS r
55
<p align="center"><img src="https://i.imgur.com/DBX2kLD.png" width=55% height=50% alt="Sriptable RSS News Widget"></p>
66

77
## Features
8-
* Display a custom RSS feed right on your lockscreen
8+
* Display a custom RSS feed right on your lock screen
99
* A click on the news opens up the article in your browser
10+
* Display the latest article
11+
* to use that, download [lockscreen-rss-widget_no_rotation.js][download_script]
12+
* Display the five latest articles in rotation
13+
* to use that, download [lockscreen-rss-widget_rotation.js][download_script]
14+
* see more under [Rotation feature]
1015

1116
## Prepare to use the widget
12-
In order to use this widget, you need to do the following steps:
17+
To use this widget, you need to do the following steps:
1318
* Install Scriptable from the [App Store]
14-
* Download the script [here]
15-
* Open the script and enter the link to the RSS feed of your favorite news site (here's how to do it: [Edit Script])
16-
* After you're done with the changes, you can add the widget to your lockscreen. These are the settings after selecting the script:
19+
* Download the script [here][download_script]
20+
* Open the script and enter the link to the RSS feed of your favorite news site (see [Edit Script])
21+
* After you're done with the changes, you can add the widget to your lock screen. These are the settings after selecting the script:
1722
* "When interacting": Run script
1823
* "Parameter": leave it blank
1924

2025
[App Store]:https://apps.apple.com/de/app/scriptable/id1405459188
21-
[here]:https://github.com/leon47331/scriptable-lockscreen-rss-widget/releases
26+
[download_script]:https://github.com/leon47331/scriptable-lockscreen-rss-widget/releases
2227
[Edit Script]:https://github.com/leon47331/scriptable-lockscreen-rss-widget/#edit-script
28+
[Rotation Feature]:https://github.com/leon47331/scriptable-lockscreen-rss-widget/#rotation-feature
29+
2330

2431
## Edit script
2532
Now that you have the script in Scriptable, it's time to enter your favorite news site.<br>
2633
These are the changes you need to make in the script:
2734

2835
```javascript
2936
const url = "RSS-FEED-URL";
30-
const srcName = "SITE-NAME"
37+
const srcName = "SITE-NAME";
3138
```
3239
Replace ```RSS-FEED-URL``` with the URL of the RSS feed you'd like to add.
33-
Replace ```SITE-NAME``` with the name of the site which will be displayed on the lockscreen.
40+
Replace ```SITE-NAME``` with the name of the site that should be displayed on the lock screen.
41+
42+
## Rotation feature
43+
Version 1.1.0 supports a rotation feature where the script automatically selects one of the 5 latest articles from the RSS feed. This value can be changed by editing the following value:
44+
```javascript
45+
const rotationValue = 5;
46+
```

0 commit comments

Comments
 (0)