2fas-browser-extension/README.md

# Open Source 2FAS Browser Extension

This is the official Browser Extension 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

- Connecting the 2FAS Browser Extension with the 2FAS Auth app
- Sending push notifications to 2FAS Auth app
- Automatic entering 2FA tokens sent by 2FAS Auth app

## 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 Browser Extension issues page](https://github.com/twofas/2fas-browser-extension/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.

For reporting security issues only, please send a detailed description of the vulnerability to security@2fas.com. Do not use this address for general inquiries or bug reports unrelated to security concerns.

## Getting Started

1. Download the Browser Extension from the [releases page](https://2fas.com/be).
2. Install the Browser Extension on your web browser.
3. Follow the on-screen instructions to set up 2FAS Extension for your 2FAS Auth app.

## Contributing

We welcome contributions to the Open Source 2FAS project. If you would like to contribute, please follow these steps:

1. Fork the repository.
2. Create a new branch for your changes.
3. Make your changes.
4. Commit your changes and push them to your fork.
5. Create a new pull request from your fork to the `develop` branch of the main repository.

We will review your pull request and, if it is approved, merge it into the main codebase.

By sharing ideas and code with the 2FAS community, either through GitHub or Discord, you agree that these contributions become the property of the 2FAS community and may be implemented into the 2FAS open source code.

## 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).
Initial Open Source commit 2023-03-21 08:20:34 +01:00			`# Open Source 2FAS Browser Extension`

			`This is the official Browser Extension 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`

			`- Connecting the 2FAS Browser Extension with the 2FAS Auth app`
			`- Sending push notifications to 2FAS Auth app`
			`- Automatic entering 2FA tokens sent by 2FAS Auth app`

			`## 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 Browser Extension issues page](https://github.com/twofas/2fas-browser-extension/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.`

Update README.md 2023-10-31 17:15:22 +01:00			`For reporting security issues only, please send a detailed description of the vulnerability to security@2fas.com. Do not use this address for general inquiries or bug reports unrelated to security concerns.`

Initial Open Source commit 2023-03-21 08:20:34 +01:00			`## Getting Started`

			`1. Download the Browser Extension from the [releases page](https://2fas.com/be).`
			`2. Install the Browser Extension on your web browser.`
			`3. Follow the on-screen instructions to set up 2FAS Extension for your 2FAS Auth app.`

			`## Contributing`

			`We welcome contributions to the Open Source 2FAS project. If you would like to contribute, please follow these steps:`

			`1. Fork the repository.`
			`2. Create a new branch for your changes.`
			`3. Make your changes.`
			`4. Commit your changes and push them to your fork.`
Update README.md 2024-02-26 18:07:32 +01:00			5. Create a new pull request from your fork to the `develop` branch of the main repository.
Initial Open Source commit 2023-03-21 08:20:34 +01:00
			`We will review your pull request and, if it is approved, merge it into the main codebase.`

			`By sharing ideas and code with the 2FAS community, either through GitHub or Discord, you agree that these contributions become the property of the 2FAS community and may be implemented into the 2FAS open source code.`

			`## 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.`

Update README.md 2023-10-31 17:15:22 +01:00			`Licensed under the [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html).`