yubioath-flutter/README

== Yubico Authenticator
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
* Add a credential by scanning a QR code on the screen
* Favorite your most used credentials for easy access
* Keep your secret seeds safe by storing them on a YubiKey
* Require a touch on YubiKey to generate the code
* Protect your credentials with a device password
* Connect an external smart card reader and use the YubiKey over NFC

=== 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, YubiKey 4 and YubiKey 5 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

Downloads for all supported operating systems are available https://developers.yubico.com/yubioath-desktop/Releases/[here].


=== System Requirements
The following operating systems are considered supported. The application may still run on other platforms.

* Windows 7 or later
* macOS High Sierra 10.13 or later
* Ubuntu 16.04 LTS or later

On Linux systems, make sure the `pcscd` service is installed and running.


=== 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`
			`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 various documents for 5.0.0 2019-09-09 16:11:31 +03:00			`* Add a credential by scanning a QR code on the screen`
			`* Favorite your most used credentials for easy access`
			`* Keep your secret seeds safe by storing them on a YubiKey`
			`* Require a touch on YubiKey to generate the code`
			`* Protect your credentials with a device password`
			`* Connect an external smart card reader and use the YubiKey over NFC`
Update README 2017-03-15 15:21:52 +03:00
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`
Update NEWS and README 2019-01-02 17:55:23 +03:00			`standalone OATH functionality found on the NEO, YubiKey 4 and YubiKey 5 series.`
Update NEWS and README 2017-03-20 11:20:16 +03:00			`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`

readme: clarify supported OSes 2019-09-18 12:09:42 +03:00			`Downloads for all supported operating systems are available https://developers.yubico.com/yubioath-desktop/Releases/[here].`
Update README 2017-03-15 15:21:52 +03:00
Mention pcscd dependency in Linux install instructions 2019-12-16 14:42:57 +03:00
readme: clarify supported OSes 2019-09-18 12:09:42 +03:00			`=== System Requirements`
			`The following operating systems are considered supported. The application may still run on other platforms.`
Update README 2017-03-15 15:21:52 +03:00
readme: clarify supported OSes 2019-09-18 12:09:42 +03:00			`* Windows 7 or later`
			`* macOS High Sierra 10.13 or later`
			`* Ubuntu 16.04 LTS or later`
Add build instructions to README 2017-11-28 16:18:21 +03:00
Move pcscd mention to system requirements 2020-01-21 13:51:17 +03:00			On Linux systems, make sure the `pcscd` service is installed and running.


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.