From 859b76be7a1c52e31cf2978b84c0cbdaaff7f9a3 Mon Sep 17 00:00:00 2001 From: Paul Lecuq Date: Wed, 24 Jul 2019 00:36:09 +0200 Subject: [PATCH] updated README --- README.md | 66 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 66 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f07ffd1 --- /dev/null +++ b/README.md @@ -0,0 +1,66 @@ +# weather + +## Summary + +weather is a small program that fetch weather informations, and store them to influxdb + +## Howto + +### Build + +```bash +go build +``` + +### Configure in weather.ini + +```ini +[influxdb] +hostname=influxdb +port=8086 +username=influxdb +password=password +database=database + +[weather] +version=2.5 +appid=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx +cities=Caen,Paris,Saint-Lo +measurements=temp,humidity,pressure +``` + +### Run + +```bash +./weather -configfile weather.ini +``` + +## License +```text +Copyright (c) 2019, PaulBSD +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +1. Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. +2. Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND +ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +The views and conclusions contained in the software and documentation are those +of the authors and should not be interpreted as representing official policies, +either expressed or implied, of the fuelprices project. +``` \ No newline at end of file