1
0
Fork 0
mirror of https://bitbucket.org/ethauvin/owm-japis.git synced 2025-04-25 09:47:11 -07:00
owm-japis-bak/README.md
Ashutosh Kumar Singh 391485a605 Update README.md
2013-08-10 23:12:50 +05:30

114 lines
3.5 KiB
Markdown

<h1>OWM JAPIs</h1>
<h4>Java APIs for OpenWeatherMap.org</h4>
OWM JAPIs lets you easily access information about current weather, weather forecasts,
daily forecasts, etc. directly from OpenWeatherMap.org by providing direct, easy-to-configure, and
easy-to-use APIs written in Java.
You can use this library to create weather applications using Java.
<h2>Downloads</h2>
Kindly download the library's binaries from http://go.aksingh.net/owm-japis-downloads
<h2>Versions</h2>
<h3>2.5 (Compatible with OWM APIs v2.5)</h3>
<h4>2.5.0.1 (latest)</h4>
<h5>Implemented:</h5>
1. Current Weather
2. Weather Forecasts
3. Daily Forecasts
4. Wind degree to direction converter
<h5>Not implemented (planned):</h5>
1. Searching of City
2. Weather Maps
3. Country code to name converter
4. Direction code to name converter
<h2>Why to use OWM JAPIs?</h2>
1. Free
2. Easy to use
3. Minimize your code
4. Lessen your efforts
Using OWM JAPIs, you only need to focus on your application and its user interface, and you can just leave
the work of accessing weather and forecast data from OpenWeatherMap.org on this library. This reduces code
in your program and improves the readability and performance of your code.
<h2>How to use OWM JAPIs?</h2>
Add OWM_JAPIs.jar and JSON.jar to your project's libararies directory, and then, code this way:
1. Create and initialize object of OpenWeatherMap
2. Call this object's functions to get desired data (current weather, forecast, etc.)
3. This object's functions returns desired data in a new object
4. Call this new object's functions to get information about weather
Using OWM JAPIs is very simple, and anyone with little coding knowledge will feel at home while making use
of this library. Identifiers are written to be self-explanatory and java documentation is also provided.
<h2>Source code</h2>
Kindly get the library's source code from http://go.aksingh.net/owm-japis-src
<h2>Bugs / Requests</h2>
Got a problem, error, or bug in the library? Or want a new feature that's not there in OWM JAPIs?
Let me know about it, and I will try to solve/add it in the next release.
Kindly post bugs or feature requests at http://go.aksingh.net/owm-japis-bugs
<h2>Developer</h2>
Ashutosh Kumar Singh
Homepage: http://www.aksingh.net
Email: me@aksingh.net
<h2>Credits</h2>
1. OpenWeatherMap.org
for providing free weather data and creating easy-to-use web APIs.
<h2>License</h2>
Copyright (C)2013 Ashutosh Kumar Singh [me@AKSingh.net]
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 shall be used for Good, not Evil.
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.