Add documentation

README.md

@@ -4,11 +4,12 @@ Kivy GUI for huami-token. Works on desktop and as Android apk. Downloads key and
 
 [huami-token](https://github.com/argrento/huami-token): all credits to the original author
 
-<img src="screenshot1.jpg" width="300" alt="screenshot" />
-<img src="screenshot2.jpg" width="300" alt="screenshot" />
+<img src="screenshots/screenshot1.jpg" width="300" alt="screenshot" />
+<img src="screenshots/screenshot2.jpg" width="300" alt="screenshot" />
 
+## Developer
 
-## Install
+### Install
 
 Install [Buildozer](https://github.com/kivy/buildozer/) and [Kivy](https://github.com/kivy/kivy)
 
@@ -19,11 +20,70 @@ or
 
 pip install -r requirements.txt
 
-## Run
+### Run
 
 python main.py
 
-## Make Android apk
+### Make Android apk
 
 buildozer -v android debug deploy run
 
+## User
+
+### Obtaining apk
+
+Either build apk as per above or get it from the [releases](https://codeberg.org/vanous/huafetcher/releases)
+
+### Signing into account
+
+This process is pretty unintuitive, so make sure to read this first! Only tested for Xiaomi login method.
+
+1) Install the apk, run it and manually give it permission for storage (only needed if you plan to fetch aGPS).
+
+<img src="screenshots/01a.jpg" width="300" alt="screenshot" />
+<img src="screenshots/01b.jpg" width="300" alt="screenshot" />
+
+2) Choose Xiaomi as login method (selected by default). Press `Get token` button. 
+
+<img src="screenshots/01.jpg" width="300" alt="screenshot" />
+
+3) This will open up your browser. Here you need to sing into your Xiaomi account.
+
+<img src="screenshots/02.jpg" width="300" alt="screenshot" />
+
+4) Once you press Sign in, your browser will warn you. This is because of invalid Xiaomi certificates (Pretty bad on their side...). So you need to get pass this warning. Screenshots show Fennec (Firefox).
+
+<img src="screenshots/03.jpg" width="300" alt="screenshot" />
+<img src="screenshots/04.jpg" width="300" alt="screenshot" />
+
+5) This gets you to a blank page, url starts with `hm.xiaomi.com/watch.do`. You must copy this URL.
+
+<img src="screenshots/05.jpg" width="300" alt="screenshot" />
+
+6) Go back to Huafetcher and paste the URL into the URL result field by using the Paste button.
+
+<img src="screenshots/06.jpg" width="300" alt="screenshot" />
+
+7) Now you can get a key or aGPS. 
+
+### Key
+
+8) For key, press `Fetch key`. The key will appear in the `Found key` field, get it by pressing the Copy button.
+
+<img src="screenshots/07.jpg" width="300" alt="screenshot" />
+
+This key must be entered into Gadgetbridge during pairing process with devices that require it
+
+<img src="screenshots/12.jpeg" width="300" alt="screenshot" />
+<img src="screenshots/13.jpeg" width="300" alt="screenshot" />
+<img src="screenshots/14.jpeg" width="300" alt="screenshot" />
+
+### aGPS
+
+8) For aGPS, press `Fetch aGPS` button. Files will be downloaded and the two important files will be unzipped into `/storage/emulated/0`. You can send them into your device with the Gadgetbridge FW/App Installer 
+
+<img src="screenshots/08.jpg" width="300" alt="screenshot" />
+<img src="screenshots/09.jpg" width="300" alt="screenshot" />
+<img src="screenshots/10.jpg" width="300" alt="screenshot" />
+<img src="screenshots/11.jpg" width="300" alt="screenshot" />
+