From fd9bd3950c40151020a13a33067f1a0ace9462e9 Mon Sep 17 00:00:00 2001
From: mar-v-in <github@rvin.mooo.com>
Date: Sun, 25 Jan 2015 01:22:44 +0100
Subject: [PATCH] Explain + usage

---
 .gitignore      |  7 +++++++
 .gitmodules     |  3 +++
 GmsApi          |  1 +
 README.md       | 20 ++++++++++++++++++++
 settings.gradle |  1 +
 5 files changed, 32 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 .gitmodules
 create mode 160000 GmsApi
 create mode 100644 settings.gradle

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 00000000..5a0e68a2
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,7 @@
+out/
+build/
+*.iml
+local.properties
+.gradle/
+gradle/
+gradlew
diff --git a/.gitmodules b/.gitmodules
new file mode 100644
index 00000000..4503545a
--- /dev/null
+++ b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "GmsApi"]
+	path = GmsApi
+	url = https://github.com/microg/android_external_GmsApi.git
diff --git a/GmsApi b/GmsApi
new file mode 160000
index 00000000..7e2f3b8f
--- /dev/null
+++ b/GmsApi
@@ -0,0 +1 @@
+Subproject commit 7e2f3b8f7b598ee243486e03f0637b8334be216f
diff --git a/README.md b/README.md
index f3f240f3..d03a1ce4 100644
--- a/README.md
+++ b/README.md
@@ -3,3 +3,23 @@ GmsLib
 This library is a compatibility implementation of the often used play-services library.
 
 It will try to use the Play Services when installed on the target device. If this is not possible, a basic fallback implementation might be used.
+
+WIP
+---
+This is still work in progress, and most applications will not build. 
+However feel free to try it out and create issues for missing method calls (please include an application to test it).
+
+Example: DashClock
+------------------
+[DashClock](https://code.google.com/p/dashclock/) is an open source clock widget with enhanced features. 
+However it uses play services as location backend and thus requires proprietary libraries to compile it. 
+
+However, it is possible to build DashClock using GmsLib, supporting all it's location features, with or without play services installed.
+To do this, download and build GmsLib plus its submodules and copy the three resulting .aar files (SafeParcel.aar, GmsApi.aar, GmsLib.aar) to `$DASHCLOCK_DIR/local_aars/`. 
+Then replace `compile 'com.google.android.gms:play-services:4.0.30'` in `$DASHCLOCK_SRC/main/build.gradle` with 
+
+	compile(name:'GmsLib', ext:'aar')
+	compile(name:'GmsApi', ext:'aar')
+	compile(name:'SafeParcel', ext:'aar')
+
+and build as usual.
diff --git a/settings.gradle b/settings.gradle
new file mode 100644
index 00000000..dbfd9faf
--- /dev/null
+++ b/settings.gradle
@@ -0,0 +1 @@
+include ':GmsApi', ':GmsApi:SafeParcel'