diff --git a/README.md b/README.md index 52b4039..5c172cd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,14 @@ -lightbox-android-webservices -============================ +# Lightbox Android Webservices framework -Lightbox Android framework for connecting to Web Services \ No newline at end of file +## Overview +This is the Lightbox Android framework for connecting to Web Services. It allows you te easily connect to any kind of web service, but it works out of the box for REST web services using Json. + +The framework is base on automatic mapping. his means that you'll need to write Java object that map the Json objects sent by the web service you want to use. + +But it's actually more than that, since it also allows you to display images from the network, easily get the location, perform background task, and contains others useful utilities classes. + +## Demo application +To understand how the framework works, the best solution is to have a look at the demo application "Tweets Nearby". This little application will display the tweets arround you, and also let you search for a foursquare place to display the twwets arround somewhere else. + + +![Tweets Nearby Screenshot](http://todo) diff --git a/tweets-neraby-screenshot.png b/tweets-neraby-screenshot.png new file mode 100644 index 0000000..42b0d2b Binary files /dev/null and b/tweets-neraby-screenshot.png differ