Refresh the README a bit

This commit is contained in:
Alexander Bakker 2020-07-27 22:02:02 +02:00
parent c0b8b2c7ee
commit 6611aa851c

View file

@ -1,45 +1,46 @@
# Aegis <img align="left" width="80" height="80" src="metadata/en-US/images/icon.png"
alt="App icon">
Aegis is a free, secure and open source 2FA app for Android. # Aegis Authenticator [![CI](https://api.travis-ci.com/beemdevelopment/Aegis.svg?branch=master)](https://travis-ci.com/github/beemdevelopment/aegis) [![Crowdin](https://badges.crowdin.net/aegis-authenticator/localized.svg)](https://crowdin.com/project/aegis-authenticator) [![Donate](https://img.shields.io/badge/donate-buy%20us%20a%20beer-%23FF813F)](https://www.buymeacoffee.com/beemdevelopment)
Aegis' security design and vault format is described in detail in [this __Aegis Authenticator__ is a free, secure and open source 2FA app for Android.
document](docs/vault.md). It aims to provide a secure authenticator for your online services, while also
including some features missing in existing authenticator apps, like proper
encryption and backups. Aegis supports HOTP and TOTP, making it compatible with
thousands of services.
# Features The security design of the app and the vault format is described in detail in
[this document](docs/vault.md).
## Features
- Free and open source - Free and open source
- Secure - Secure
- Encryption (AES-256) - The vault is encrypted (AES-256-GCM), and can be unlocked with:
- Password (scrypt) - Password (scrypt)
- Biometrics (Android Keystore) - Biometrics (Android Keystore)
- Screen capture prevention - Screen capture prevention
- Tap to reveal ability - Tap to reveal
- Multiple ways to add new entries
- Scan QR code
- Enter details manually
- Import from files
- andOTP
- FreeOTP
- Aegis
- Import from apps (requires root):
- Google Authenticator
- Steam
- Supported algorithms:
- HOTP ([RFC 4226](https://tools.ietf.org/html/rfc4226))
- TOTP ([RFC 6238](https://tools.ietf.org/html/rfc6238))
- Steam ([RFC 6238](https://tools.ietf.org/html/rfc6238) with custom
encoding)
- Compatible with Google Authenticator - Compatible with Google Authenticator
- Supports industry standard algorithms:
[HOTP](https://tools.ietf.org/html/rfc4226) and
[TOTP](https://tools.ietf.org/html/rfc6238)
- Lots of ways to add new entries
- Scan a QR code or an image of one
- Enter details manually
- Import from other authenticator apps: Authenticator Plus, Authy, andOTP,
FreeOTP, FreeOTP+, Google Authenticator, Microsoft Authenticator, Plain
text, Steam, TOTP Authenticator and WinAuth (root access is required for
some of these)
- Organization - Organization
- Custom or default icons - Alphabetic/custom sorting
- Drag and drop - Custom or automatically generated icons
- Custom groups - Group entries together
- Advanced entry editing - Advanced entry editing
- Material design with multiple themes: - Search by name/issuer
- Light theme - Material design with multiple themes: Light, Dark, AMOLED
- Dark theme
- Amoled / true dark theme
- Export (plaintext or encrypted) - Export (plaintext or encrypted)
- Automatic backups of the vault to a location of your choosing
## Screenshots ## Screenshots
@ -106,25 +107,13 @@ Certificate fingerprints:
- [aegis-icons](https://github.com/krisu5/aegis-icons) - [aegis-icons](https://github.com/krisu5/aegis-icons)
While we're still working on better icon support in Aegis, krisu5 has started While we're still [working on better icon
a third-party repository for icons that you may want to check out. support](https://github.com/beemdevelopment/Aegis/issues/509) in Aegis, krisu5
has started a third-party repository for icons that you may want to check out.
[<img width=500 alt="Aegis-icons preview" [<img width=500 alt="Aegis-icons preview"
src="https://raw.githubusercontent.com/krisu5/aegis-icons/master/showcase.png">](https://github.com/krisu5/aegis-icons) src="https://raw.githubusercontent.com/krisu5/aegis-icons/master/showcase.png">](https://github.com/krisu5/aegis-icons)
## 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
- [CircleImageView](https://github.com/hdodenhof/CircleImageView) by Henning
Dodenhof
- [barcodescanner](https://github.com/dm77/barcodescanner) by Dushyanth
- [libsu](https://github.com/topjohnwu/libsu) by John Wu
## License ## License
This project is licensed under the GNU General Public License v3.0. See the This project is licensed under the GNU General Public License v3.0. See the