Skip to content

Commit

Permalink
Update Readme (#30)
Browse files Browse the repository at this point in the history
Fixes #29
  • Loading branch information
jlcvp authored Oct 28, 2024
1 parent 29db365 commit 84d3763
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,26 @@ An open-source, self-hosted alternative to Twilio's Authy, capable of syncing or

All the firebase integration is optional, and we currently don't offer a SaaS option (because rea$ons), but you change the `environment.x.ts` files to use your own firebase project or you can use the app fully offline, but in this case you will need to manually export and import your accounts between devices.

## Current and Planned Features
## Live version on github pages
https://jlcvp.github.io/AuthLeu

## Features
- [x] Progressive Web App (PWA) support.
- [x] Add 2FA accounts by scanning QR code or manually entering the secret key and account details.
- [x] Logo search
- [ ] Edit 2FA account details.
- [ ] Delete/disable/hide 2FA accounts.
- [x] Sync 2FA accounts across multiple devices using Firebase Firestore.
- [x] Import/Export 2FA accounts as a JSON file.
- [x] 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] Encryption of 2FA Secret keys.
- [ ] Support for other 2FA algorithms like pure HOTP.
- [x] Internationalization
- [x] English
- [x] Portuguese (Brazil)
- [ ] Other languages support (HELP WANTED)
- [x] Dark mode support.

## Live version on github pages
https://jlcvp.github.io/AuthLeu

## Screenshots
### Portrait layout
Expand Down
Binary file modified resources/screenshots/screenshot_1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified resources/screenshots/screenshot_2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 84d3763

Please sign in to comment.