From 6b46f993ca1ecd43a9131b478f31d21f509cb123 Mon Sep 17 00:00:00 2001 From: Carlgo11 Date: Wed, 15 Nov 2023 01:07:36 +0100 Subject: [PATCH] modify contributing and readme markdown code --- CONTRIBUTING.md | 4 ++++ README.md | 35 ++++++++++++++++++++++------------- 2 files changed, 26 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ebd09b3..8842316 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -176,6 +176,10 @@ If linking to more than one, add each category in an array. ### Icons +> **Note** +> If you're adding a website that already exists on 2fa.directory, you can skip this step.\ +> The website automatically falls back to serving the image from 2fa.directory. + Icons enhance brand recognition and contribute to a cohesive user experience within the Passkeys Directory. When adding a new entry, including an icon is mandatory. Icons should be placed in `img/` subdirectories and named after the entry's domain. For instance, the icon for `youtube.com` should be in `img/y/` and named `youtube.com.svg` or `youtube.com.png`. diff --git a/README.md b/README.md index 982cedb..08b6162 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,40 @@ -# Passkeys Directory - Data & API +

Passkeys Directory - Data & API

-[![Twitter](https://img.shields.io/badge/Twitter-@2faorg-1DA1F2.svg?style=for-the-badge&logo=Twitter)][twitter] -[![Sponsor](https://img.shields.io/github/sponsors/2factorauth?color=db61a2&logo=GitHub&style=for-the-badge)][sponsor] +

+ + + +

[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/