Update README and configuration template to include Weather widget setup details
This commit is contained in:
parent
57f7898d65
commit
52d3b1196b
@ -4,7 +4,8 @@ ArinDash is a customizable terminal dashboard (TUI) written in Go, powered by [`
|
||||
|
||||
## Features
|
||||
|
||||
- **Clock & Date**: Real-time time and date display.
|
||||
- **Clock, Date & Calendar**: Real-time time, date, and calendar display.
|
||||
- **Weather**: Current weather information via OpenWeatherMap.
|
||||
- **Pi-hole Integration**: Monitor your Pi-hole statistics, including query counts and blocked percentages.
|
||||
- **Docker Monitoring**: View the status of your Docker containers.
|
||||
- **HTTP Prober**: Check the availability and status codes of your favorite websites.
|
||||
@ -43,6 +44,7 @@ ArinDash uses a `config.toml` file for its settings. A template is provided as `
|
||||
2. Edit `config.toml` with your specific details:
|
||||
- **Pi-hole**: Set your host and API password.
|
||||
- **WiFi**: Configure your SSID and password for the QR code widget.
|
||||
- **Weather**: Provide your OpenWeatherMap API key and Location ID. You can find your Location ID in the `city.list.json.gz` from [OpenWeatherMap bulk data](http://bulk.openweathermap.org/sample/).
|
||||
|
||||
3. Customize widgets:
|
||||
- **Websites**: Copy `websites_template.json` to `websites.json` and update it with the URLs and icons you want to monitor.
|
||||
|
||||
@ -8,3 +8,8 @@ Password = "generate-an-app-password-in-pi-hole"
|
||||
Auth = "WPA"
|
||||
SSID = "YourSSID"
|
||||
Password = "YourPassword"
|
||||
|
||||
[openWeatherMap]
|
||||
#ID from http://bulk.openweathermap.org/sample/city.list.json.gz; unzip the gz file and find your city
|
||||
LocationId = "0000000"
|
||||
ApiKey = "YourApiKey"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user