diff --git a/README.md b/README.md new file mode 100644 index 00000000..18346ba9 --- /dev/null +++ b/README.md @@ -0,0 +1,63 @@ +# Aegis + +Aegis is a free, secure and open source 2FA app for Android. + +# Features + +- Free and open source +- Multiple ways to add new entries + - Scan QR code + - Enter details manually +- Compatible with Google Authenticator +- Organization + - Custom or default avatars + - Drag and drop + - Custom groups + - Advanced entry editing +- Material design + - Light and dark themes +- Security + - Encryption + - Password + - Fingerprint + - Screen capture prevention +- Import + - Aegis + - andOTP + - FreeOTP +- Export (plaintext or encrypted) +- Supported algorithms: + - TOTP ([RFC 6238](https://tools.ietf.org/html/rfc6238)) + - HOTP ([RFC 4226](https://tools.ietf.org/html/rfc4226)) + +## Screenshots + +[Main Activity](assets/screenshot_main.png?raw=true) +[Settings Activity](/assets/screenshot_settings.png?raw=true) +[Edit Activity](/assets/screenshot_edit.png?raw=true) + +[Main Activity](assets/screenshot_main_group.png?raw=true) +[Main Activity](assets/screenshot_main_dark.png?raw=true) + +## Downloads + +Aegis is available in the Google Play Store. + +[Get it on Google Play]() + +There are plans to make it available on F-Droid as well. + +## Libraries + +- [TextDrawable](https://github.com/amulyakhare/TextDrawable) by Amulya Khare +- [FloatingActionButton](https://github.com/Clans/FloatingActionButton) by Dmytro Tarianyk +- [AppIntro](https://github.com/AppIntro/AppIntro) by Paolo Rotolo +- [Krop](https://github.com/avito-tech/krop) by Avito Technology +- [SpongyCastle](https://github.com/rtyley/spongycastle) by Roberto Tyley +- [Swirl](https://github.com/mattprecious/swirl) by Matthew Precious +- [CircleImageView](https://github.com/hdodenhof/CircleImageView) by Henning Dodenhof +- [barcodescanner](https://github.com/dm77/barcodescanner) by Dushyanth + +## License + +This project is licensed under the GNU General Public License v3.0. See the [LICENSE](LICENSE) file for details. diff --git a/assets/screenshot_edit.png b/assets/screenshot_edit.png new file mode 100644 index 00000000..8e889658 Binary files /dev/null and b/assets/screenshot_edit.png differ diff --git a/assets/screenshot_main.png b/assets/screenshot_main.png new file mode 100644 index 00000000..e5ca8b7a Binary files /dev/null and b/assets/screenshot_main.png differ diff --git a/assets/screenshot_main_dark.png b/assets/screenshot_main_dark.png new file mode 100644 index 00000000..d3eeb805 Binary files /dev/null and b/assets/screenshot_main_dark.png differ diff --git a/assets/screenshot_main_group.png b/assets/screenshot_main_group.png new file mode 100644 index 00000000..70bc59d9 Binary files /dev/null and b/assets/screenshot_main_group.png differ diff --git a/assets/screenshot_settings.png b/assets/screenshot_settings.png new file mode 100644 index 00000000..89748e8d Binary files /dev/null and b/assets/screenshot_settings.png differ