weather/README.md

69 lines
1.6 KiB
Markdown

# Weather
[![Version](https://img.shields.io/badge/latest_version-1.0.2-green.svg)](https://git.yaegashi.fr/nishiki/weather/releases)
[![GoReport](https://goreportcard.com/badge/git.yaegashi.fr/nishiki/weather)](https://goreportcard.com/report/git.yaegashi.fr/nishiki/weather)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/weather/src/branch/master/LICENSE)
weather is a small program that fetch weather informations, and store them to influxdb
## How to
### Build
- Install [golang](https://golang.org/doc/install)
- Download and build
```bash
git clone https://git.yaegashi.fr/nishiki/weather
cd weather
go build
```
### Sample config
```yaml
---
openweathermap:
api_key: XXXX
units: metric
influxdb:
url: http://127.0.0.1:8086
database: test
measurement: weather
username: weather
password: secret
cities:
- Paris
- York,GB
interval: 600
```
### Run
- Run in oneshot mode
```bash
weather -config weather.yml
```
- Run in daemon mode
```bash
weather -config weather.yml -daemon
```
## License
```text
Copyright (c) 2019 Adrien Waksberg
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```