yubioath-flutter/README

== Yubico Authenticator
image:https://travis-ci.org/Yubico/yubioath-desktop.svg?branch=master["Build Status", link="https://travis-ci.org/Yubico/yubioath-desktop"]
image:https://ci.appveyor.com/api/projects/status/tddss2exet3ysypt?svg=true["Appveyor Status", link="https://ci.appveyor.com/project/Yubico53275/yubioath-desktop-xfr6h/"]

Cross-platform application for generating Open Authentication (OATH) time-based TOTP and event-based HOTP one-time password codes, with the help of a YubiKey that protects the shared secrets.

image:screenshot.png[]

=== Features
* Keep your OATH secrets safe by storing them on a YubiKey and generate the codes with this application.
* Add a credential by scanning a QR code on the screen.
* Supports 6, 7 or 8 digit codes.
* Supports TOTP credentials with any time period.
* Require touch on YubiKey to generate code.
* Protect your credentials with a device password.

=== Supported devices
Usage of this software requires a compatible YubiKey device. Yubico
Authenticator is capable of provisioning and using both slot-based credentials
(compatible with any YubiKey that supports OTP) as well as the more powerful
standalone OATH functionality found on the NEO and YubiKey 4 series.
To use the standalone OATH functionality your YubiKey must have the CCID mode enabled,
which can be done by using the https://developers.yubico.com/yubikey-manager-qt/[YubiKey Manager].

=== Installation

==== Windows and macOS
Installers are available https://developers.yubico.com/yubioath-desktop/Releases/[here].

==== Ubuntu

    $ sudo apt-add-repository ppa:yubico/stable
    $ sudo apt update
    $ sudo apt install yubioath-desktop

=== CLI

Looking for a command line option? That is available in https://developers.yubico.com/yubikey-manager/[YubiKey Manager CLI] with the `ykman oath` commands.
Update README 2017-03-15 15:21:52 +03:00			`== Yubico Authenticator`
Add badges to README 2017-03-22 14:30:01 +03:00			`image:https://travis-ci.org/Yubico/yubioath-desktop.svg?branch=master["Build Status", link="https://travis-ci.org/Yubico/yubioath-desktop"]`
Update appveyor badge 2017-09-18 14:47:29 +03:00			`image:https://ci.appveyor.com/api/projects/status/tddss2exet3ysypt?svg=true["Appveyor Status", link="https://ci.appveyor.com/project/Yubico53275/yubioath-desktop-xfr6h/"]`
Update README 2017-03-15 15:21:52 +03:00
			`Cross-platform application for generating Open Authentication (OATH) time-based TOTP and event-based HOTP one-time password codes, with the help of a YubiKey that protects the shared secrets.`

			`image:screenshot.png[]`

			`=== Features`
Update README 2017-03-20 11:23:15 +03:00			`* Keep your OATH secrets safe by storing them on a YubiKey and generate the codes with this application.`
Update README 2017-03-15 15:21:52 +03:00			`* Add a credential by scanning a QR code on the screen.`
Update README 2017-09-18 10:35:08 +03:00			`* Supports 6, 7 or 8 digit codes.`
			`* Supports TOTP credentials with any time period.`
Update README 2017-03-15 15:21:52 +03:00			`* Require touch on YubiKey to generate code.`
			`* Protect your credentials with a device password.`

Update NEWS and README 2017-03-20 11:20:16 +03:00			`=== Supported devices`
			`Usage of this software requires a compatible YubiKey device. Yubico`
			`Authenticator is capable of provisioning and using both slot-based credentials`
			`(compatible with any YubiKey that supports OTP) as well as the more powerful`
			`standalone OATH functionality found on the NEO and YubiKey 4 series.`
			`To use the standalone OATH functionality your YubiKey must have the CCID mode enabled,`
			`which can be done by using the https://developers.yubico.com/yubikey-manager-qt/[YubiKey Manager].`

Update README 2017-03-15 15:21:52 +03:00			`=== Installation`

			`==== Windows and macOS`
			`Installers are available https://developers.yubico.com/yubioath-desktop/Releases/[here].`

Update README 2017-03-15 15:36:02 +03:00			`==== Ubuntu`
Update README 2017-03-15 15:21:52 +03:00
			`$ sudo apt-add-repository ppa:yubico/stable`
			`$ sudo apt update`
			`$ sudo apt install yubioath-desktop`
Add build instructions to README 2017-11-28 16:18:21 +03:00
README: add note about CLI 2018-07-02 11:25:05 +03:00			`=== CLI`

			Looking for a command line option? That is available in https://developers.yubico.com/yubikey-manager/[YubiKey Manager CLI] with the `ykman oath` commands.