update readme of weather widget
This commit is contained in:
parent
7df447fb50
commit
cb394af13a
|
@ -4,6 +4,28 @@
|
||||||
|
|
||||||
Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder.
|
Note that widget uses the Arc icon theme, so it should be [installed](https://github.com/horst3180/arc-icon-theme#installation) first under **/usr/share/icons/Arc/** folder.
|
||||||
|
|
||||||
|
## Customization
|
||||||
|
|
||||||
|
It is possible to customize widget by providing a table with all or some of the following config parameters:
|
||||||
|
|
||||||
|
| Name | Default | Description |
|
||||||
|
|---|---|---|
|
||||||
|
| `font` | `Play 9` | Font |
|
||||||
|
| `city` | `Montreal,ca` | City name and country code, [more info](https://openweathermap.org/current) |
|
||||||
|
| `api_key` | none| API key, required |
|
||||||
|
| `units` | `metric` | `metric` for celsius, `imperial` for fahrenheit |
|
||||||
|
|
||||||
|
### Example:
|
||||||
|
|
||||||
|
```lua
|
||||||
|
weather_widget({
|
||||||
|
api_key = 'your-api-key',
|
||||||
|
units = 'imperial',
|
||||||
|
font = 'Ubuntu Mono 9'
|
||||||
|
}),
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
1. Install lua socket - to make HTTP calls to get the weather information.
|
1. Install lua socket - to make HTTP calls to get the weather information.
|
||||||
|
@ -24,7 +46,7 @@ Note that widget uses the Arc icon theme, so it should be [installed](https://gi
|
||||||
git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
|
git clone https://github.com/streetturtle/awesome-wm-widgets.git ~/.config/awesome/
|
||||||
```
|
```
|
||||||
|
|
||||||
1. Get Open Weather Map app id here: [openweathermap.org/appid](https://openweathermap.org/appid) and place it in **~/.config/awesome/awesome-wm-widgets/secrets.lua**, or directly in the widget. Don't forget to set also your city and units - C/F.
|
1. Get Open Weather Map app id here: [openweathermap.org/appid](https://openweathermap.org/appid).
|
||||||
|
|
||||||
1. Require weather widget at the beginning of **rc.lua**:
|
1. Require weather widget at the beginning of **rc.lua**:
|
||||||
|
|
||||||
|
@ -39,7 +61,14 @@ Note that widget uses the Arc icon theme, so it should be [installed](https://gi
|
||||||
{ -- Right widgets
|
{ -- Right widgets
|
||||||
layout = wibox.layout.fixed.horizontal,
|
layout = wibox.layout.fixed.horizontal,
|
||||||
...
|
...
|
||||||
weather_widget,
|
--default
|
||||||
|
weather_widget({api_key = 'your-api-key'}),
|
||||||
|
--customized
|
||||||
|
weather_widget({
|
||||||
|
api_key = 'your-api-key',
|
||||||
|
units = 'imperial',
|
||||||
|
font = 'Ubuntu Mono 9'
|
||||||
|
})
|
||||||
...
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue