Skip to content
This repository has been archived by the owner on Oct 19, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Levminer authored Oct 12, 2022
1 parent 270b9f1 commit 62fb6b9
Showing 1 changed file with 1 addition and 58 deletions.
59 changes: 1 addition & 58 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,58 +1 @@
# Authme

- Simple cross-platform two-factor (2FA) authenticator app for desktop.

[![Downloads](https://img.shields.io/github/downloads/levminer/authme/total?label=Downloads)](https://authme.levminer.com/#downloads)
[![Support](https://img.shields.io/badge/Support-PayPal-blue)](https://paypal.me/levminer)
[![License](https://img.shields.io/github/license/levminer/authme?label=License)](https://github.com/Levminer/authme/blob/main/LICENSE.md)

## Features

- 🔒 Secure by design: Your codes is secured by AES 256bit encryption with your own password.
- 🔑 Import codes: Import form any 2FA TOTP QR code or import directly from Google Authenticator.
- ⌨️ Many shortcuts: Easily open Authme with custom shortcuts and the app will start with your system for quick and easy access.
- 📡 Completely offline: You own your data, internet is only required for updates.
- 💻 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

- 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.

## Screenshot

<img src="https://raw.githubusercontent.com/Levminer/authme/dev/screenshots/application.png?raw=true">

## Downloads (Release)

- Latest release version for users that want a stable and polished experience.

[![Latest release](https://img.shields.io/github/package-json/v/levminer/authme/main?label=Release)](https://tooomm.github.io/github-release-stats/?username=Levminer&repository=authme)
[![Download](https://img.shields.io/badge/Windows,%20Linux,%20macOS-download-brightgreen)](https://authme.levminer.com/#downloads)
[![Updated](https://img.shields.io/github/last-commit/levminer/authme/main?color=yellowgreen&label=Updated)](https://github.com/Levminer/authme/releases)

- Also available on: [Microsoft Store](https://link.levminer.com/authme-ms-store), [Snapcraft](https://snapcraft.io/authme), [winget](https://winstall.app/apps/Levminer.Authme)

## Downloads (Alpha)

- Latest alpha version for users that want to try out new features early.

[![Latest alpha](https://img.shields.io/github/package-json/v/levminer/authme/dev?label=Alpha&color=blue)](https://tooomm.github.io/github-release-stats/?username=Levminer&repository=authme)
[![Download](https://img.shields.io/badge/Windows,%20Linux,%20macOS-download-brightgreen)](https://authme.levminer.com/#downloads-alpha)
[![Updated](https://img.shields.io/github/last-commit/levminer/authme/dev?color=yellowgreen&label=Updated)](https://github.com/Levminer/authme/actions/workflows/alpha-artifacts.yml)

## Translating

- Help translate Authme: [Translation](https://github.com/Levminer/authme/blob/main/.github/CONTRIBUTING.md#translation)
- You can translate on Crowdin to: [Crowdin](https://crowdin.com/project/authme-2fa)

## 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)

## License

- This software is licensed under: [GPL-3.0](https://github.com/Levminer/authme/blob/main/LICENSE.md)
- If you are planning to use this software as a business please contact me at: <authme@levminer.com>
Merged to [https://github.com/Levminer/authme](https://github.com/Levminer/authme)

0 comments on commit 62fb6b9

Please sign in to comment.