From 6ed9ef74ad2aac8880d6abd3ec68a0fb10627318 Mon Sep 17 00:00:00 2001 From: octogradiste Date: Fri, 12 Apr 2024 14:24:34 +0200 Subject: [PATCH] Add install guide to README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 36cc08a4c..5e45d52ca 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ # Echo +## Installation + +### Release + +Go to [releases](https://github.com/echo-swent/echo/releases) and download the `app-debug.apk` asset from the latest release. + +### Artifact + +Go to the [Android APK Build](https://github.com/echo-swent/echo/actions/workflows/android.yml) workflow and download the `echo-app.apk` artifact from the latest successful run. + +## Authentication + +If you have trouble logging in, please use the following test credentials: + +- test@example.com +- 123456 + +> [!NOTE] +> Make sure you are on the login page before entering the test credentials. + ## Architecture ![Architecture](architecture.png) \ No newline at end of file