-
-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
19 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,46 +1,38 @@ | ||
# 2FA.Directory Data | ||
# 2FA Directory API & Data | ||
|
||
[![Build Status](https://img.shields.io/github/actions/workflow/status/2factorauth/twofactorauth/repository.yml?branch=master&style=for-the-badge)][build_status] | ||
[![License](https://img.shields.io/badge/license-mit-9A0F2D.svg?style=for-the-badge)][license] | ||
[![Twitter](https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=twitter)][twitter] | ||
[![Twitter](https://img.shields.io/badge/[email protected]?style=for-the-badge&logo=Twitter)][twitter] | ||
[![Sponsor](https://img.shields.io/github/sponsors/2factorauth?color=db61a2&logo=GitHub&style=for-the-badge)][sponsor] | ||
|
||
A list of popular sites and whether or not they support two factor authentication. | ||
[2FA Directory][site_url] is an open source project that aims to improve online security by providing a directory of websites and services that support two-factor authentication (2FA). Our community-driven platform allows anyone to contribute to the list, making it the most comprehensive directory of its kind. | ||
|
||
## The Goal :goal_net: | ||
|
||
The goal of this project is to build a website ([2fa.directory][site_url]) with a list of popular sites that support | ||
two factor authentication, as well as the methods that they provide. | ||
|
||
Our hope is to aid consumers who are deciding between alternative services based on the security they | ||
offer for their customers. This project also serves as an indicator of general security efforts used on a site. | ||
Our hope is that this directory can aid consumers who are deciding between alternative services based on the security they offer for their customers. This project also serves as an indicator of general security efforts used on a site. | ||
|
||
## Contributing :pencil2: | ||
|
||
2fa.directory is only possible thanks to community contributions. We welcome all contributions to the project. | ||
If you would like to contribute, please read the entire guidelines in | ||
[CONTRIBUTING.md][contrib]. | ||
[2FA Directory][site_url] is only possible thanks to community contributions. We welcome all contributions to the project. | ||
If you would like to contribute, please read the entire guidelines in [CONTRIBUTING.md][contrib]. | ||
|
||
Please note that this repository only contains the data files for the list. Everything concerning the [2fa.directory][site_url] website is located in the [frontend] repository. | ||
This repository contains the directory data for [2FA Directory][site_url]. | ||
For the website frontend code, see [2factorauth/frontend][frontend]. | ||
|
||
## Third party usage | ||
|
||
We welcome anyone to use our data however we discourage scraping the data directly from this Git repository as changes we make might break your program. | ||
Instead we recommend you use our [API](https://2fa.directory/api/). | ||
Instead we recommend you use our [API][api]. | ||
|
||
We provide API access free of charge, however, the project does incur regular bills to maintain. Therefore, if you use the data for commercial purposes, please consider sponsoring us here on [GitHub][sponsor]. | ||
|
||
We always appreciate people letting us know how they use our data so please drop us a few lines about your project if you decide to use our API! 😊 | ||
|
||
## License :balance_scale: | ||
|
||
This code is distributed under the MIT license. For more info, read the | ||
[LICENSE][license] file distributed with the source code. | ||
This code is distributed under the MIT license. For more info, read the [LICENSE][license] file distributed with the source code. | ||
|
||
[build_status]: https://github.com/2factorauth/twofactorauth/actions | ||
[license]: /LICENSE.md | ||
[gitter]: https://gitter.im/2factorauth/twofactorauth | ||
[twitter]: https://twitter.com/2faorg | ||
[site_url]: https://2fa.directory | ||
[api]: https://2fa.directory/api/ | ||
[contrib]: /CONTRIBUTING.md | ||
[jekyll]: https://jekyllrb.com/ | ||
[pages-gem]: https://github.com/github/pages-gem | ||
[docker]: https://www.docker.com/ | ||
[frontend]: https://github.com/2factorauth/frontend | ||
[frontend]: https://github.com/2factorauth/frontend/ | ||
[license]: /LICENSE.md | ||
[site_url]: https://2fa.directory/ | ||
[sponsor]: https://github.com/sponsors/2factorauth/ | ||
[twitter]: https://twitter.com/2faorg/ |