Update readme

.github/CONTRIBUTING.md

@@ -14,12 +14,6 @@
 -   Follow Developing instructions
 -   Run build command: `npm run build` (You can only build for your own OS)
 
-## NPM commands
-
--   Start app: `npm run start`
--   Build app: `npm run build`
--   Lint app: `npm run lint`
-
 ## Contributing rules
 
 1. Use NPM
@@ -40,4 +34,4 @@
 
 ## Notes
 
--   Changelog: `git log --pretty=format:'* [[%h](https://github.com/Levminer/authme/commit/%h)] %s (%cs)' --since=5.weeks > log.txt`
+-   Changelog: `git log --pretty=format:'* [[%h](https://github.com/Levminer/authme/commit/%h)] %s (%cs)' 3.2.0..HEAD > log.txt`

CHANGELOG.md

@@ -1,5 +1,6 @@
 ### Authme 3.2.0 (2022. April 12.)
 
+* [[c610a35](https://github.com/Levminer/authme/commit/c610a35)] Update readme and changelog (2022-04-11)
 * [[7b3d8c0](https://github.com/Levminer/authme/commit/7b3d8c0)] Experimental change passwords #183 (2022-04-11)
 * [[e7e5a7f](https://github.com/Levminer/authme/commit/e7e5a7f)] Update packages (2022-04-11)
 * [[0841e90](https://github.com/Levminer/authme/commit/0841e90)] Types (2022-04-11)

README.md

@@ -1,60 +1,56 @@
 # Authme
 
--   Simple cross platform two-factor authentication app for desktop.
+-   Simple cross-platform two-factor (2FA) authenticator app for desktop.
 
-[![Downloads](https://img.shields.io/github/downloads/levminer/authme/total?label=Downloads)](https://tooomm.github.io/github-release-stats/?username=Levminer&repository=authme)
+[![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">
+
 ## Latest 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://github.com/Levminer/authme/releases)
+[![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)
 [![Windows Download](https://img.shields.io/badge/Windows-download-brightgreen)](https://api.levminer.com/api/v1/authme/release/windows)
 [![Linux Download](https://img.shields.io/badge/Linux-download-brightgreen)](https://api.levminer.com/api/v1/authme/release/linux)
 [![Mac Download](https://img.shields.io/badge/Mac-download-brightgreen)](https://api.levminer.com/api/v1/authme/release/mac)
 [![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), [winget](https://winstall.app/apps/Levminer.Authme)
 
-<img src="https://raw.githubusercontent.com/Levminer/authme/dev/screenshots/application.png?raw=true">
-
 ## Latest 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://github.com/Levminer/authme/actions/workflows/alpha-artifacts.yml)
+[![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)
 [![Windows Download](https://img.shields.io/badge/Windows-download-brightgreen)](https://api.levminer.com/api/v1/authme/alpha/windows)
 [![Linux Download](https://img.shields.io/badge/Linux-download-brightgreen)](https://api.levminer.com/api/v1/authme/alpha/linux)
 [![Mac Download](https://img.shields.io/badge/Mac-download-brightgreen)](https://api.levminer.com/api/v1/authme/alpha/mac)
 [![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)
 
-## Features
-
--   🔒 Secure by design: Your codes is secured by AES 256bit encryption and 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: You can export your 2FA codes anytime, you can export everything very easily.
-
-
-## How to use
-
--   For detailed instructions check out the: [Docs](https://docs.authme.levminer.com/#/import?id=import)
--   If you just want to test the app download this sample import file, unzip it, and import it to Authme: [Download](https://github.com/Levminer/authme/blob/main/sample/authme_import_sample.zip?raw=true)
-
 ## 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)
 
-## Importing
-
--   From QR codes: You screenshot all the QR codes from your favorite websites, and import all of them to Authme
--   From Google Authenticator: Import all of your saved QR codes from your Google Authenticator app.
-
 ## Contributing and development
 
 -   Read for development and building instructions: [Contributing](https://github.com/Levminer/authme/blob/main/.github/CONTRIBUTING.md)

package.json

@@ -33,7 +33,8 @@
 		"win": {
 			"target": [
 				"nsis",
-				"zip"
+				"zip",
+				"appx"
 			],
 			"icon": "img/icon.ico",
 			"artifactName": "authme-${version}-windows-x64-portable.zip"