2fas-android/README.md
Rafał Kobyłko 4b77d84dd6 Merge pull request #19 from FineFindus/patch-1
docs: link to project setup
2023-05-03 21:53:41 +02:00

44 lines
2.0 KiB
Markdown

# Open Source 2FAS for Android
This is the official Android app for the Open Source 2FAS project.
## What is 2FAS?
2FAS (Two-Factor Authentication Service) is a user authentication method that provides an additional layer of security for online accounts. In addition to a username and password, 2FAS uses a second factor, such as a one-time password (OTP) shown on a user's phone, to verify a user's identity. This helps prevent unauthorized access to accounts, even if a password is compromised.
## Features
- Support for time-based one-time passwords (TOTP) and HMAC-based on-time passwords (HOTP)
- Compatible with any service that supports the TOTP and HOTP standard, including Google, Microsoft, and Dropbox
- Easy to set up and use
## Graphics
Please note that the graphics used in this app are not part of the open source project and are subject to their own separate licensing terms.
## Bug Reporting
We use GitHub for bug reports. Please visit the [2FAS for Android issues page](https://github.com/twofas/2fas-android/issues) to search for and report any bugs you may have found. Before adding a new issue, please search for existing issues to avoid duplicates.
## Getting Started
1. Download the app from the [releases page](https://2fas.com).
2. Install the app on your Android device.
3. Follow the on-screen instructions to set up 2FAS for your online accounts.
## Contributing
We welcome contributions to the Open Source 2FAS project. If you would like to contribute, please see the [contribution guide](./CONTRIBUTING.md).
## Donations
If you would like to support the development of the Open Source 2FAS project, you can [make a donation](https://2fas.com/donate). All donations will be used to support the ongoing development and maintenance of the project.
We appreciate your support!
## License
Copyright (c) Two Factor Authentication Service, Inc. All rights reserved.
Licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).