Skip to content

Commit 23d515d

Browse files
[Readme] Updated Readme to mention requirements and instructions to download
1 parent 4dacdba commit 23d515d

1 file changed

Lines changed: 27 additions & 0 deletions

File tree

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22
<img src="readme_assets/fallback_squircle_logo.png" alt="logo" width="150" height="150"/>
33
<h1>Fallback</h1>
44
</div>
5+
6+
Downloads from GitHub Releases: ![Downloads](https://img.shields.io/github/downloads/lightningbolt047/Fallback/total)
7+
58
<div>
69
<h2>About</h2>
710
<p>An application you "Fallback" to when you don't have access to your 2FA codes. Fallback is built using Flutter and follows Material Design 3. The Android app is now available on Google Play Store.</p>
@@ -21,6 +24,30 @@
2124
</ul>
2225
</div>
2326

27+
<div>
28+
<h2>Requirements</h2>
29+
<ul>
30+
<li>
31+
Android 10+
32+
</li>
33+
<li>
34+
Biometric authentication of some sort (Mostly Fingerprint since most Face Unlock implementations are incompatible with this app).
35+
</li>
36+
<li>
37+
GMS (Google Mobile Services) if you want to use Cloud Sync.
38+
</li>
39+
</ul>
40+
</div>
41+
42+
<div>
43+
<h2>How do I download?</h2>
44+
<p>The app can be downloaded in two ways:</p>
45+
<ul>
46+
<li>Google Play Store: The easiest method, search for "Fallback" and install the app from there.</li>
47+
<li>Github Releases: For those who cannot or do not want to install from the Google Play Store can download the apk from this repo's releases. Do note that OTA updates do not work if the app is installed through this method and the user has to manually update the app.</li>
48+
</ul>
49+
</div>
50+
2451
<div>
2552
<img src="readme_assets/store_securely.png" alt="store_securely" width="253.333" height="506.666"/>
2653
<img src="readme_assets/cloud_sync.png" alt="store_securely" width="253.333" height="506.666"/>

0 commit comments

Comments
 (0)