Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
soyrubio committed Oct 19, 2020
1 parent 32a5256 commit 33c70b2
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 506 deletions.
2 changes: 1 addition & 1 deletion MMM-idos.js
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Module.register('MMM-idos', {
fadePoint: 0.25, // Start on the 1/4th of the list
fade: true,
blink: true,
torPorts: ['9050', '9052', '9053', '9054']
torPorts: []
},

getStyles: function () {
Expand Down
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,20 @@ var config = {
module: 'MMM-idos',
header: 'Praha Masarykovo n.', // no header will be displayed if ommited
position: 'top_right', // position of the module

config: {
stopId: 'Praha%20Masarykovo%20n.', // "https://idos.idnes.cz/vlakyautobusymhdvse/odjezdy/vysledky/?f=the_stop
torPorts: ['9050', '9052'], // tor won't be used if ommited
/* other configurations */
}
}
]
}
```

If Tor ports are selected, the module will randomly choose one to access to the idos.cz website.
If you want to set up Tor for anonymous access, and don't know how to, [you can read this article](https://levelup.gitconnected.com/anonymous-web-scrapping-with-node-js-tor-apify-and-cheerio-3b36ec6a45dc).

## Configuration options

| Option | Description
Expand All @@ -43,10 +48,11 @@ var config = {
| `refreshInterval` | *Optional* How often to check for the next lines. <br><br> **Type:** `int`<br> **Default value:** `30000` milliseconds (60 seconds)
| `fade` | *Optional* Fade the future lines to black. (Gradient) <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `fadePoint` | *Optional* Where to start fade? <br><br> **Type:** `float`<br> **Default value:** `0.25` (start on the 1/4 th of the list)
| `blink` | *Optional* Whether departures should blink when departure time is <1 min. > <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `blink` | *Optional* Whether departures should blink when departure time is <1 min. <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `displaySymbol` | *Optional* Whether to display bus/tram symbols. <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `displayLineNumber` | *Optional* Whether to display line number. <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `displayDestination` | *Optional* Whether to display destination stop. <br><br> **Type:** `boolean`<br> **Default value:** `true`
| `torPorts` | *Optional* Tor ports, which will be randomly chosen to access the website, if ommited, Tor won't be used <br><br> **Type:** `array ot strings`<br> **Default value:** `[]`

## Credits

Expand Down
Loading

0 comments on commit 33c70b2

Please sign in to comment.