updated README and LICENSE information

Issue #1
master
Blaine Motsinger 4 years ago
parent 9e5f1e5d08
commit dc6f39be86
  1. 23
      LICENSE
  2. 42
      README.md
  3. 8
      weather

@ -0,0 +1,23 @@
The MIT License (MIT)
Copyright (c) 2019 Blaine Motsinger
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

@ -5,10 +5,10 @@ cli program to get the weather for your location
## SYNOPSIS
```
weather [--zip] <int>
[--current] [--forecast]
weather [--current]
[--version]
[--help] [--man]
[--devel] [--debug]
```
## DESCRIPTION
@ -18,40 +18,56 @@ This program will retrieve weather condition and forecast details for your locat
## OPTIONS
```
--zip specify where you want weather results for
geolocation lookup will be performed without zip
--current print the current conditions
--forecast print the next 4 day forecast
--version print the version and exit
--help print this dialogue
--man display the full documentation
--devel use a development tier key for openweathermap
--debug dump the internals and query responses
```
## EXAMPLES
### get the current conditions for a specified zip code
### get the current conditions
```
weather --zip 77095 --current
weather --current
```
### get the current conditions and 4 day forecast
## CONFIGURATION
```
weather --zip 77095 --current --forecast
```
The configuration file for weather is located in the homedir of the running user, named .weatherrc
### get the 4 day forecast only, via geolocation
The file may contain two sections, production and development, under the parent section, openweathermap.
```
weather --forecast
~ $ cat .weatherrc
[openweathermap]
production = 1q2w3e4r5t6y7u8i9o0p1q2w3e4r5t6y
development = 0p9o8i7u6y5t4r3e2w1q0p9o8i7u6y5t
```
The development section is required in the case of using the --devel switch for weather.
The production section is required in normal operation.
## DEPENDENCIES
- Getopt::Long
- Pod::Usage
- File::HomeDir
- Config::Tiny
- HTTP::Tiny
- JSON::MaybeXS
- Data::Dumper
## AUTHOR
Blaine Motsinger, <blaine@renderorange.com>
## LICENSE AND COPYRIGHT
This software is available under the MIT license.
Copyright (c) 2019 Blaine Motsinger

@ -153,7 +153,7 @@ This program will retrieve weather condition and forecast details for your locat
The configuration file for weather is located in the homedir of the running user, named .weatherrc
The file may contain two sections, production and development, under the parent section, openweathermap
The file may contain two sections, production and development, under the parent section, openweathermap.
~ $ cat .weatherrc
[openweathermap]
@ -188,4 +188,10 @@ The production section is required in normal operation.
Blaine Motsinger, <blaine@renderorange.com>
=head1 LICENSE AND COPYRIGHT
This software is available under the MIT license.
Copyright (c) 2019 Blaine Motsinger
=cut

Loading…
Cancel
Save