-
-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
modify contributing and readme markdown code
- Loading branch information
Showing
2 changed files
with
26 additions
and
13 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
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,30 +1,40 @@ | ||
# Passkeys Directory - Data & API | ||
<h1 align="center">Passkeys Directory - Data & API</h1> | ||
|
||
[![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] | ||
<p align="center"> | ||
<a href="https://twitter.com/2faorg/"><img src="https://img.shields.io/badge/X/[email protected]?style=for-the-badge&logo=x"/></a> | ||
<a href="https://infosec.exchange/@2factorauth"><img src="https://img.shields.io/badge/Mastodon-@2factorauth-6364FF?style=for-the-badge&logo=mastodon"/></a> | ||
<a href="https://github.com/sponsors/2factorauth/"><img src="https://img.shields.io/github/sponsors/2factorauth?color=db61a2&logo=GitHub&style=for-the-badge"/></a> | ||
</p> | ||
|
||
[Passkeys Directory][site_url] is an open-source project that aims to improve online security by providing a directory of | ||
websites and services that support passkey authentication. Our community-driven platform allows anyone to | ||
contribute to the list, making it the most comprehensive directory of its kind. | ||
websites and services that support passkey authentication. Our community-driven platform allows anyone to contribute to | ||
the list, making it the most comprehensive directory of its kind. | ||
|
||
## Contributing :pencil2: | ||
## Usage | ||
|
||
[Passkeys Directory][site_url] is only possible thanks to community contributions. | ||
We welcome all contributions to the project, but please read the [CONTRIBUTING.md][contrib] before beginning. | ||
### General usage | ||
|
||
This repository contains the directory data for [Passkeys Directory][site_url]. | ||
For the website code, see [2factorauth/passkeys.2fa.directory][frontend]. | ||
To view the directory, go to [passkeys.2fa.directory][site_url]. | ||
You can either open one category at a time or use the search function to look up a website. | ||
|
||
## Third-party usage | ||
### API 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 that 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 | ||
API access is provided 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 appreciate hearing about how you use our data. Please let us know about your project if you use our API. 😊 | ||
|
||
## Contribute :pencil2: | ||
|
||
[Passkeys Directory][site_url] is only possible thanks to community contributions. | ||
We welcome all contributions to the project, but please read [CONTRIBUTING.md][contrib] before beginning. | ||
|
||
> **Note**\ | ||
> For the [Passkeys Directory][site_url] website code, go to [2factorauth/passkeys.2fa.directory][frontend]. | ||
## License :balance_scale: | ||
|
||
The data in this repository is licensed under a Creative Commons Attribution 4.0 International License. | ||
|
@@ -39,4 +49,3 @@ Our intention is to showcase and utilize these images in a manner that respects | |
[contrib]: /CONTRIBUTING.md | ||
[site_url]: https://passkeys.2fa.directory/ | ||
[frontend]: https://github.com/2factorauth/frontend/ | ||
[twitter]: https://twitter.com/2faorg/ |