Skip to content

Commit

Permalink
Update changelog and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Levminer committed Mar 4, 2024
1 parent 72f0c71 commit ba7dd33
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 7 deletions.
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- Clone the repository: `git clone https://github.com/Levminer/authme`
- Install node modules: `npm i`
- Setup project: `npm run setup`
- Run start command: `npm run start`
- Run start command: `npm run dev`

## Building

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ body:
attributes:
label: Authme/System information
description: Paste the version information here (Settings > About > About Authme > Copy).
placeholder: "Authme: 2.6.0 ..."
placeholder: "Authme: 5.0.0 ..."
validations:
required: true
- type: textarea
Expand Down
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
### Authme 5.0.1 (2024. February 20.)

- [[df7b932](https://github.com/Levminer/authme/commit/df7b932)] Bump version and update tauri and deps (2024-02-20)
- [[334e1ea](https://github.com/Levminer/authme/commit/334e1ea)] Simplify import page (2024-02-20)
- [[999d3aa](https://github.com/Levminer/authme/commit/999d3aa)] Further decrease text size (2024-02-16)
- [[e4cf062](https://github.com/Levminer/authme/commit/e4cf062)] Update icons (2024-02-15)
- [[72bd649](https://github.com/Levminer/authme/commit/72bd649)] Update website and readme links (2024-02-15)
- [[3d7acbd](https://github.com/Levminer/authme/commit/3d7acbd)] Fix analytics mode (2024-02-15)

### Authme 5.0.0 (2024. February 13.)

- [[b70b99e](https://github.com/Levminer/authme/commit/b70b99e)] Bump version (2024-02-13)
Expand Down
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
- 💻 Privacy in mind: Authme is hidden from video capture and screenshots.
- 📃 Easy export and backup: You can export your 2FA codes anytime and you can create a backup of your codes very easily.

## Compatible 2FA codes
## Supported 2FA types

- TOTP 2FA QR code: A TOTP QR code is that you find mostly everywhere, if you want to setup 2FA. Example: Google, Facebook, Microsoft, etc.
- Google Authenticator QR code: A Google Authenticator QR code is what you can export, and contains all of your already imported codes. Example: Google Authenticator.
- TOTP: A TOTP QR code is that you find mostly everywhere, if you want to setup 2FA. Example: Google, Facebook, Microsoft, etc.
- Google Authenticator: If you are already using Google Authenticator you can export all of your exiting codes and import them to Authme.
- 2FAS Authenticator: You can create a backup of all your codes in 2FAS and import the backup in Authme.
- Aegis Authenticator: You can export your vault from Aegis and import it to Authme.

## Screenshot

Expand Down Expand Up @@ -57,8 +59,8 @@ Tutorial on how to migrate to Authme 4 or 5 from Authme 3:

## Contributing and development

- Read for development and building instructions: [Contributing](https://github.com/Levminer/authme/blob/main/.github/CONTRIBUTING.md)
- Read before contributing: [Code Of Conduct](https://github.com/Levminer/authme/blob/main/.github/CODE_OF_CONDUCT.md)
- Contributions are always welcome! Read for development and building instructions: [Contributing](https://github.com/Levminer/authme/blob/main/.github/CONTRIBUTING.md)
- Do you want to translate Authme? [Instructions](https://github.com/Levminer/authme/issues/258)

## License

Expand Down

0 comments on commit ba7dd33

Please sign in to comment.