Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jlcvp committed Sep 8, 2024
1 parent caca1f8 commit 1b8af70
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,27 @@

![logo](resources/icon_256.png)
# AuthLeu
An open source, Self-hosted synced or fully offline alternative to Twilio's Authy (but can also substitute Google Authenticator, Microsoft authenticator and other TOTP 2FA Apps).
[![GitHub pages deploy](https://github.com/jlcvp/AuthLeu/actions/workflows/deploy_gh_pages.yml/badge.svg)](https://github.com/jlcvp/AuthLeu/actions/workflows/deploy_gh_pages.yml)
An open-source, self-hosted alternative to Twilio's Authy, capable of syncing or operating fully offline. It can also serve as a substitute for TOTP 2FA apps like Google Authenticator and Microsoft Authenticator.

If you want, you may sync your 2FA tokens and have your own URL using Firebase Firestore and Firebase Hosting with your google account.
If preferred, you can synchronize your 2FA tokens and have your own URL using Firebase Firestore and Firebase Hosting with your Google account.

## Current and Planned Features
- [x] Progressive Web App (PWA) support.
- [x] Add 2FA accounts by scanning QR code or manually entering the secret key and account details.
- [ ] Edit 2FA account details.
- [ ] Delete/disable/hide 2FA accounts.
- [x] Sync 2FA accounts across multiple devices using Firebase Firestore.
- [ ] Sync 2FA accounts across multiple devices using an exported file.
- [x] Import/Export 2FA accounts as a JSON file.
- [ ] Import/Export only selected 2FA accounts.
- [ ] Encrypt 2FA Secrets in the local storage using a master password.
- [ ] Encrypt 2FA Secrets in the firestore using a master password.
- [ ] Support for other 2FA methods like HOTP.
- [x] Internationalization.
- [x] Internationalization
- [x] English
- [x] Portuguese (Brazil)
- [ ] Other languages support (HELP WANTED)
- [x] Dark mode support.

## Screenshots
### Portrait layout
Expand Down

0 comments on commit 1b8af70

Please sign in to comment.