From 5af2eef7cf9bdd2243f5451e0c7f576a57fdb802 Mon Sep 17 00:00:00 2001
From: Salvatore Testa <sal.testa@gmail.com>
Date: Sat, 5 Feb 2022 19:34:25 -0800
Subject: [PATCH] Add a README with setup instructions

Put a `.keep` file in the `app/libs` folder so folks can put the `.aar`
file in there without needing to make it first.
---
 .gitignore     |  1 +
 README.md      | 58 ++++++++++++++++++++++++++++++++++++++++++++++++++
 app/libs/.keep |  0
 3 files changed, 59 insertions(+)
 create mode 100644 README.md
 create mode 100644 app/libs/.keep

diff --git a/.gitignore b/.gitignore
index 52ead0e..33c2885 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,3 +16,4 @@
 local.properties
 /app/libs/yggdrasil.aar
 /app/libs/yggdrasil-sources.jar
+.idea
\ No newline at end of file
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9555c42
--- /dev/null
+++ b/README.md
@@ -0,0 +1,58 @@
+# Yggdrasil Android
+
+Reference implementation for connecting to the Yggdrasil Network from Android devices
+
+# Build
+
+Download this repository and
+the [Go Yggdrasil repository](https://github.com/yggdrasil-network/yggdrasil-go).
+
+```
+git clone git@github.com:yggdrasil-network/yggdrasil-android.git
+git clone git@github.com:yggdrasil-network/yggdrasil-go.git
+
+# or
+
+git clone https://github.com/yggdrasil-network/yggdrasil-android.git
+git clone https://github.com/yggdrasil-network/yggdrasil-go.git
+```
+
+## Generate the Android artifact (.aar) from the Go repository
+
+Build the Android artifact from the `yggdrasil-go` repo.
+
+```
+# from yggdrasil-go
+./contrib/mobile/build -a
+```
+
+If you check the folder, there should now be a `yggdrasil-sources.jar` and `yggdrasil.aar` there.
+
+## Move the Android artifact to the Android repository
+
+From the Android repo, copy `yggdrasil.aar` into the `app/libs` folder.
+
+```
+# from yggdrasil-android
+cp ../yggdrasil-go/yggdrasil.aar app/libs/
+```
+
+## Build and install the Android app
+
+With your Android device connected or emulator running, build and install the app.
+
+```
+# from yggdrasil-android
+./gradlew :app:installDebug
+```
+
+# Configure
+
+## Peer
+
+Add a peer from the [public peer list](https://publicpeers.neilalexander.dev/). Make sure to change
+the "enable" toggle from off to on to make sure the peer(s) get picked up.
+
+## Explore
+
+Try out pages from the [list of services](https://yggdrasil-network.github.io/services.html).
diff --git a/app/libs/.keep b/app/libs/.keep
new file mode 100644
index 0000000..e69de29