diff --git a/docs/widgets.md b/docs/widgets.md index 1fc3f211..f0740f7c 100644 --- a/docs/widgets.md +++ b/docs/widgets.md @@ -109,12 +109,21 @@ Keep track of price changes of your favorite crypto assets. Data is fetched from **Field** | **Type** | **Required** | **Description** --- | --- | --- | --- -**`assets`** | `string` | Required | An array of cryptocurrencies, coins and tokens. See [list of supported assets](https://api.coingecko.com/api/v3/asset_platforms) +**`assets`** | `string` | _Optional_ | An array of cryptocurrencies, coins and tokens. See [list of supported assets](https://api.coingecko.com/api/v3/asset_platforms). If none are specified, then the top coins by `sortBy` (defaults to market cap) will be returned **`currency`** | `string` | _Optional_ | The fiat currency to display price in, expressed as an ISO-4217 alpha code (see [list of currencies](https://www.iban.com/currency-codes)). Defaults to `USD` -**`sortBy`** | `number` | _Optional_ | The method of sorting results. Can be `marketCap`, `volume` or `alphabetical`. Defaults to `marketCap`. +**`sortBy`** | `string` | _Optional_ | The method of sorting results. Can be `marketCap`, `volume` or `alphabetical`. Defaults to `marketCap`. +**`limit`** | `number` | _Optional_ | Number of results to return, useful when no assets are specified. Defaults to either `all` or `100` ##### Example +```yaml +- type: crypto-watch-list + options: + limit: 10 +``` + +Or + ```yaml - type: crypto-watch-list options: @@ -279,6 +288,32 @@ Renders a programming or generic joke. Data is fetched from the [JokesAPI](https category: Programming ``` +### Flight Data + +Displays airport departure and arrival flights, using data from [AeroDataBox](https://www.aerodatabox.com/). Useful if you live near an airport and often wonder where the flight overhead is going to. Hover over a row for more flight data. + +
+ Live {{ direction !== 'both' ? direction: 'flight' }} data from {{ airport }} +
+ +{{ flight.time | formatDate }}
+{{ flight.number }}
+{{ flight.airport }}
+{{ flight.time | formatDate }}
+{{ flight.number }}
+{{ flight.airport }}
+