Skip to content

Commit 378f050

Browse files
committed
Update README
1 parent 0ced9f8 commit 378f050

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,17 @@
44
[<img src="https://badge.fury.io/gh/mattrubin%2Fauthenticator@2x.png" alt="GitHub version" height="18px">](http://badge.fury.io/gh/mattrubin%2Fauthenticator)
55
[![Build Status](https://travis-ci.org/mattrubin/authenticator.svg?branch=master)](https://travis-ci.org/mattrubin/authenticator)
66

7-
This app generates and displays one-time passwords for logging into systems which use two-factor authentication, or any other system which supports [counter-based](https://tools.ietf.org/html/rfc4226) or [time-based](https://tools.ietf.org/html/rfc6238) OTPs. The goal of this project is to create a free, simple, open-source alternative to Google Authenticator. This project was based on the neglected open-source [Google Authenticator](https://code.google.com/p/google-authenticator/) client for iOS, and has been rewritten to create a clean code-base using modern APIs.
87

9-
OTP secret keys can be entered into the app manually, via an iOS cross-app URL scheme, or by scanning a QR code with the in-app QR reader. The [format for key URIs](https://code.google.com/p/google-authenticator/wiki/KeyUriFormat) is supported by many OTP apps and is often presented to the user as a QR code when they are activating two-factor authentication for an online account.
8+
Authenticator is a simple, free, and open source two-factor authentication app. It helps keep your online accounts secure by generating unique one-time passwords, which you use in combination with your other passwords to log into supporting websites. The simple combination of the password in your head and the rotating passwords generated by the app make it much harder for anyone but you to access your accounts.
9+
10+
- Easy: Simple setup via QR code, ["otpauth://" URL](https://code.google.com/p/google-authenticator/wiki/KeyUriFormat), or manual entry
11+
- Secure: All data is stored in encrypted form on the iOS keychain
12+
- Compatible: Full support for [time-based](https://tools.ietf.org/html/rfc6238) and [counter-based](https://tools.ietf.org/html/rfc4226) one-time passwords as standardized in RFC 4226 and 6238
13+
- Off the Grid: The app never connects to the internet, and your secret keys never leave your device.
1014

1115

1216
## License
1317

14-
This project is made available under the terms of the [MIT License](http://opensource.org/licenses/MIT). The original project on which it is based is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). Files present in the earlier project still bear the original license in their header comments. Files which are new or have been entirely rewritten contain the new license in their headers.
18+
This project is made available under the terms of the [MIT License](http://opensource.org/licenses/MIT).
19+
20+
The modern Authenticator grew out of the abandoned source for [Google Authenticator](https://code.google.com/p/google-authenticator/) for iOS. The original Google code on which this project was based is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)