Add README.md

This commit is contained in:
Alexander Bakker 2019-02-07 22:44:23 +01:00
parent 62425511a1
commit 9ef94e2262
6 changed files with 63 additions and 0 deletions

63
README.md Normal file
View file

@ -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
[<img width=200 alt="Main Activity" src="assets/screenshot_main.png?raw=true">](assets/screenshot_main.png?raw=true)
[<img width=200 alt="Settings Activity" src="assets/screenshot_settings.png?raw=true">](/assets/screenshot_settings.png?raw=true)
[<img width=200 alt="Edit Activity" src="assets/screenshot_edit.png?raw=true">](/assets/screenshot_edit.png?raw=true)
[<img width=200 alt="Main Activity" src="assets/screenshot_main_group.png?raw=true">](assets/screenshot_main_group.png?raw=true)
[<img width=200 alt="Main Activity" src="assets/screenshot_main_dark.png?raw=true">](assets/screenshot_main_dark.png?raw=true)
## Downloads
Aegis is available in the Google Play Store.
[<img height=80 alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" />]()
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.

BIN
assets/screenshot_edit.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 131 KiB

BIN
assets/screenshot_main.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 231 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 233 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 197 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 192 KiB