Updating README.md file (screenshots and descriptions)
authorGustavo Martin Morcuende <gu.martinm@gmail.com>
Mon, 24 Nov 2014 01:03:56 +0000 (02:03 +0100)
committerGustavo Martin Morcuende <gu.martinm@gmail.com>
Mon, 24 Nov 2014 01:03:56 +0000 (02:03 +0100)
README.md
screenshots/about.png [new file with mode: 0644]
screenshots/current.png [new file with mode: 0644]
screenshots/forecast_chosen_day.png [new file with mode: 0644]
screenshots/location.png [new file with mode: 0644]
screenshots/logo.png [new file with mode: 0644]
screenshots/main_forecast.png [new file with mode: 0644]
screenshots/missing_app_key.png [new file with mode: 0644]
screenshots/settings.png [new file with mode: 0644]
screenshots/widget.png [new file with mode: 0644]
screenshots/widget_settings.png [new file with mode: 0644]

index d0e30aa..c934803 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,4 +1,88 @@
-WeatherInformation
+Weather Information
 =========================
 
-Weather Information, App for Android
+<p align="center">
+  <img src="screenshots/logo.png?raw=true" alt="Sublime's custom image"/>
+</p>
+
+Weather Information is a simple and made for fun Android application for displaying current weather conditions and weather forecast worldwide. It implements a simple and clear user interface by means of default Android layouts and libraries.
+
+Features:
+ * One widget displaying the current weather conditions is available for the home and lock screens (widget updates weather data once every 60 minutes)
+ * Turn on location access on your device and Weather Information will be able to find out your current location.
+ * Notifications for the current weather conditions can be turned on and off.
+ * You can change the units of measurement for the weather data in the preferences dialog.
+ * Weather Information allows you to modify the refresh interval for the displayed data and the notifications (depending on your cell phone plan you might want to increase or decrease the refresh interval in order to save money)
+ * Until fourteen days forecast.
+ * No ads, this application is completely for free.
+ * Weather Information is an open source application, what means, you can download and mofify the source code (Apache License, Version 2.0). Indeed, we encourage you to do it.
+
+
+Weather data are provided by **[OpenWeatherMap]**(http://openweathermap.org/). OpenWeatherMap developers recommend to obtain an [API key](http://openweathermap.org/appid), this key can be added in the preferences window of the application. There are different [prices](http://openweathermap.org/price) (from free to enterprise) depending on the availability and reliability of the weather data. It is up to you which one to use.
+**If you have an API key, be careful when using this application in public networks because everyone connected to that network could see your private API key** (Weather Information is using plain HTTP connections for retrieving data from OpenWeatherMap servers)
+
+
+**Internationalization**: currently, Weather Information just displays weather data in English format. Because it is an open source application you can add as many languages as you wish just downloading the source code (you can collaborate to improve this application, if you wish)
+
+
+## Forecast
+
+Choose how many days of forecast you want to be displayed (fourteen days by default). Weather Information also shows you the maximum and minimum temperatures for the displayed days with a nice representation of the weather conditions for each one.
+
+![main_forecast](screenshots/main_forecast.png)
+
+
+## Current conditions
+
+Weather Information is able to display the current weather conditions: the maximum and minimum temperatures, humidity, wind, rain, pressure and many other data. In the preferences window you can modify the units of measurement for almost every data (choose whatever you like)
+
+![current](screenshots/current.png)
+
+
+## Weather forecast for some day
+
+In the forecast window, just select one day and Weather Information will provide you with more information about the chosen one.
+
+![forecasth_chosen_day](screenshots/forecast_chosen_day.png)
+
+
+## Pick your location
+
+Using the map included in this application you can mark your chosen location in an easy way. If location access is available just press the *Get Location* button and Weather Information will pick your current location for you.
+
+![location](screenshots/location.png)
+
+
+## Preferences
+
+There are many settings that can be changed in the preferences window: units of measurement, refresh intervals, enable or disable notifications, your OpenWeatherMap [API key](http://openweathermap.org/appid) and many others.
+
+![settings](screenshots/settings.png)
+
+
+## Widget
+
+Just a simple widget with the current weather conditions. You can use it for the home and lock screens.
+
+![widget](screenshots/widget.png)
+
+
+## Widget preferences
+
+Weather Information allows you to change a couple of parameters of your widget: you can decide whether to show the country field or not and the units of measurement can also be changed. Instead of waiting for the automatic refresh (for the widget it is every 60 minutes) you can press the *Refresh* button and the displayed weather data will be updated.
+
+![widget_settings](screenshots/widget_settings.png)
+
+
+## Notice about missing OpenWeatherMap application ID
+
+Even if OpenWeatherMap can work without it, the OpenWeatherMap maintainers recommend to use an [API key](http://openweathermap.org/appid). Weather Information will show you a warning message when you do not have an API key. If you do not want to be bothered again with this message, just press the *OK* button and the warning popup will be dismissed forever.
+
+![missing_app_key](screenshots/missing_app_key.png)
+
+
+## About
+
+Go to the about window if you want to learn more about the developers behind this application. Also, you will find third party files and libraries that are used by this application and their respective licenses.
+
+![about](screenshots/about.png)
diff --git a/screenshots/about.png b/screenshots/about.png
new file mode 100644 (file)
index 0000000..da6d98b
Binary files /dev/null and b/screenshots/about.png differ
diff --git a/screenshots/current.png b/screenshots/current.png
new file mode 100644 (file)
index 0000000..6656cfa
Binary files /dev/null and b/screenshots/current.png differ
diff --git a/screenshots/forecast_chosen_day.png b/screenshots/forecast_chosen_day.png
new file mode 100644 (file)
index 0000000..58549dd
Binary files /dev/null and b/screenshots/forecast_chosen_day.png differ
diff --git a/screenshots/location.png b/screenshots/location.png
new file mode 100644 (file)
index 0000000..e69a4d5
Binary files /dev/null and b/screenshots/location.png differ
diff --git a/screenshots/logo.png b/screenshots/logo.png
new file mode 100644 (file)
index 0000000..52d4b9d
Binary files /dev/null and b/screenshots/logo.png differ
diff --git a/screenshots/main_forecast.png b/screenshots/main_forecast.png
new file mode 100644 (file)
index 0000000..2953388
Binary files /dev/null and b/screenshots/main_forecast.png differ
diff --git a/screenshots/missing_app_key.png b/screenshots/missing_app_key.png
new file mode 100644 (file)
index 0000000..90076ad
Binary files /dev/null and b/screenshots/missing_app_key.png differ
diff --git a/screenshots/settings.png b/screenshots/settings.png
new file mode 100644 (file)
index 0000000..09604ea
Binary files /dev/null and b/screenshots/settings.png differ
diff --git a/screenshots/widget.png b/screenshots/widget.png
new file mode 100644 (file)
index 0000000..fab2d8f
Binary files /dev/null and b/screenshots/widget.png differ
diff --git a/screenshots/widget_settings.png b/screenshots/widget_settings.png
new file mode 100644 (file)
index 0000000..ffcd7b5
Binary files /dev/null and b/screenshots/widget_settings.png differ