Added Readme

1 files changed, 37 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..7f575f5
--- /dev/null
+++ b/README
@@ -0,0 +1,37 @@
+blaupload-android
+=================
+
+This is a new Android app for blaupload. It's still in development and 
+lacks most important features. Use the old version for now: 
+http://blatech.co.uk/wjoe/blauploader
+
+Requirements
+============
+
+- Android 4.0.3 or higher
+- Tested on a HTC One M8 and Sony Xperia Z running 4.4
+- Assumed to work on any reasonable Android device
+
+Reasons
+=======
+
+- Learn more about Android development
+- Replace bad code from the old version, rather than adding to it
+- Utilise the new JSON features of blaupload
+- Create a general purpose app which can be used for many other sites
+
+Libraries Used
+==============
+
+- (Otto)[http://square.github.io/otto/] - Event Bus library for passing 
+  data between threads
+
+Tutorials/Resources Used
+========================
+
+- (Javatechig - Image GridView)[http://javatechig.com/android/android-gridview-example-building-image-gallery-in-android]
+- (Vogella - AsyncTask)[http://www.vogella.com/tutorials/AndroidBackgroundProcessing/article.html#concurrency_asynchtask3]
+- (Volegga - JSON in Android)[http://www.vogella.com/tutorials/AndroidJSON/article.html]
+- (Volegga - ListViews and Adapters)[http://www.vogella.com/tutorials/AndroidListView/article.html]
+- (Baeldung - Apache HttpClient cookies)[http://www.baeldung.com/httpclient-4-cookies]
+- (SimonVT - Using Otto for AsyncTask)[http://simonvt.net/2014/04/17/asynctask-is-bad-and-you-should-feel-bad/]