From 992b16b473c3f71dc441e00fbf74da385df25641 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Michelle=20=22MishManners=C2=AE=E2=84=A2=22=20Mannering?= <36594527+mishmanners@users.noreply.github.com> Date: Mon, 30 Oct 2023 11:40:34 +1100 Subject: [PATCH] Accessibility features for README.md Add accessibility features based on: https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible/ --- README.md | 110 +++++++++++++++++++++++------------------------------- 1 file changed, 47 insertions(+), 63 deletions(-) diff --git a/README.md b/README.md index cc19670a8fc3..7b11430ab80a 100644 --- a/README.md +++ b/README.md @@ -25,25 +25,25 @@ The single API to access payment ecosystems across 130+ countries

- + CI/CD label - + Apache license label - + Rust label

-

πŸŽ‰ Hacktoberfest is here! πŸŽ‰

+

:tada: Hacktoberfest is here! :tada:

-New to Rust? Hyperswitch is the perfect place to start this hacktoberfest! 😁 +New to Rust? Hyperswitch is the perfect place to start this hacktoberfest! :grin: -> ⭐️ If you're new to Hacktoberfest, you can learn more and register to participate [here](https://hacktoberfest.com/participation/). Registration is from **September 26th - October 31st**. +> :star: If you're new to Hacktoberfest, you can learn more and register to participate [here](https://hacktoberfest.com/participation/). Registration is from **September 26th - October 31st**.
- +Hyperswitch illustration showing various payment systems plugging into one switch board; the board is representative of Hyperswitch Hyperswitch is an open source payments switch to make payments fast, reliable, and, affordable. It lets you connect with multiple payment processors and route traffic effortlessly, all with a single API integration. @@ -51,24 +51,24 @@ It lets you connect with multiple payment processors and route traffic effortles Using Hyperswitch, you can: -- ⬇️ **Reduce dependency** on a single processor like Stripe or Braintree -- πŸ§‘β€πŸ’» **Reduce Dev effort** by 90% to add & maintain integrations -- πŸš€ **Improve success rates** with seamless failover and auto-retries -- πŸ’Έ **Reduce processing fees** with smart routing -- 🎨 **Customize payment flows** with full visibility and control -- 🌐 **Increase business reach** with local/alternate payment methods +- :arrow_down: **Reduce dependency** on a single processor like Stripe or Braintree +- :tipping_hand_person: **Reduce Dev effort** by 90% to add & maintain integrations +- :rocket: **Improve success rates** with seamless failover and auto-retries +- :money_with_wings: **Reduce processing fees** with smart routing +- :art: **Customize payment flows** with full visibility and control +- :globe_with_meridians: **Increase business reach** with local/alternate payment methods > Hyperswitch is **wire-compatible** with top processors like Stripe, making it easy to integrate.
-Hyperswitch-Product +Hyperswitch-Product chart showing how it fits into your system -

⚑️ Quick Start Guide

+

:zap: Quick Start Guide

 - +Sign up button Ways to get started with Hyperswitch: @@ -77,7 +77,7 @@ Ways to get started with Hyperswitch: No code or setup is required in your system, [learn more](/docs/try_sandbox.md) - +registration button 2. A simple demo of integrating Hyperswitch with your React App, Try our React [Demo App](https://github.com/aashu331998/hyperswitch-react-demo-app/archive/refs/heads/main.zip). @@ -87,36 +87,30 @@ Ways to get started with Hyperswitch: Suitable if you like to customise the core offering, [setup guide](/docs/try_local_system.md) -

πŸ”Œ Fast Integration for Stripe Users

+

:electric_plug: Fast Integration for Stripe Users

 If you are already using Stripe, integrating with Hyperswitch is fun, fast & easy. Try the steps below to get a feel for how quick the setup is: -1. Get API keys from our [dashboard]. +1. Get API keys from our [dashboard](https://app.hyperswitch.io/register). 2. Follow the instructions detailed on our - [documentation page][migrate-from-stripe]. - -[dashboard]: https://app.hyperswitch.io/register -[migrate-from-stripe]: https://hyperswitch.io/docs/migrateFromStripe + [documentation page](https://hyperswitch.io/docs/migrateFromStripe). -

βœ… Supported Features

+

:white_check_mark: Supported Features

 -### 🌟 Supported Payment Processors and Methods +### :star2: Supported Payment Processors and Methods As of Sept 2023, we support 50+ payment processors and multiple global payment methods. In addition, we are continuously integrating new processors based on their reach and community requests. Our target is to support 100+ processors by H2 2023. You can find the latest list of payment processors, supported methods, and -features -[here][supported-connectors-and-features]. - -[supported-connectors-and-features]: https://docs.google.com/spreadsheets/d/e/2PACX-1vQWHLza9m5iO4Ol-tEBx22_Nnq8Mb3ISCWI53nrinIGLK8eHYmHGnvXFXUXEut8AFyGyI9DipsYaBLG/pubhtml?gid=0&single=true +features [on our supported features and connectors page](https://docs.google.com/spreadsheets/d/e/2PACX-1vQWHLza9m5iO4Ol-tEBx22_Nnq8Mb3ISCWI53nrinIGLK8eHYmHGnvXFXUXEut8AFyGyI9DipsYaBLG/pubhtml?gid=0&single=true) -### 🌟 Hosted Version +### :star2: Hosted Version In addition to all the features of the open-source product, our hosted version provides features and support to manage your payment infrastructure, compliance, @@ -145,16 +139,14 @@ analytics, and operations end-to-end: - Custom dashboards with deep analytics, alerts, and reporting - Expert team to consult and improve business metrics -You can [try the hosted version in our sandbox][dashboard]. +You can [try the hosted version in our sandbox](). -

πŸ€” FAQs

+

:thinking: FAQs

 Got more questions? -Please refer to our [FAQs page][faqs]. - -[faqs]: https://hyperswitch.io/docs/devSupport +Please refer to our [FAQs page](https://hyperswitch.io/docs/devSupport). - -

What's Included❓

+ +

What's Included :question:

 Within the repositories, you'll find the following directories and files, @@ -183,7 +175,7 @@ and the various connector integrations under the `src/connector` sub-directory. -### 🌳 Files Tree Layout +### :deciduous_tree: Files Tree Layout @@ -219,10 +211,10 @@ should be introduced, checking it agrees with the actual structure --> ``` -

πŸ’ͺ Join us in building Hyperswitch

+

:muscle: Join us in building Hyperswitch

 -### 🀝 Our Belief +### :handshake: Our Belief > Payments should be open, fast, reliable and affordable to serve > the billions of people at scale. @@ -237,7 +229,7 @@ Why should devs across companies repeat the same work? Why can't it be unified and reused? Hence, Hyperswitch was born to create that reusable core and let companies build and customise it as per their specific requirements. -### ✨ Our Values +### :sparkles: Our Values 1. Embrace Payments Diversity: It will drive innovation in the ecosystem in multiple ways. @@ -248,7 +240,7 @@ reusable core and let companies build and customise it as per their specific req Security and Performance SLAs. 5. Maximise Value Creation: For developers, customers & partners. -### 🀍 Contributing +### :heart: Contributing This project is being created and maintained by [Juspay](https://juspay.in), South Asia's largest payments orchestrator/switch, processing more than 50 @@ -266,7 +258,7 @@ We welcome contributions from the community. Please read through our Included are directions for opening issues, coding standards, and notes on development. -πŸ¦€ **Important note for Rust developers**: We aim for contributions from the community +:crab: **Important note for Rust developers**: We aim for contributions from the community across a broad range of tracks. Hence, we have prioritised simplicity and code readability over purely idiomatic code. For example, some of the code in core functions (e.g., `payments_core`) is written to be more readable than @@ -278,19 +270,14 @@ pure-idiomatic. Get updates on Hyperswitch development and chat with the community: -- Read and subscribe to [the official Hyperswitch blog][blog]. -- Join our [Discord server][discord]. -- Join our [Slack workspace][slack]. -- Ask and explore our [GitHub Discussions][github-discussions]. - -[blog]: https://hyperswitch.io/blog -[discord]: https://discord.gg/wJZ7DVW8mm -[slack]: https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg -[github-discussions]: https://github.com/juspay/hyperswitch/discussions +- Read and subscribe to [the official Hyperswitch blog](https://hyperswitch.io/blog). +- Join our [Discord server](https://discord.gg/wJZ7DVW8mm). +- Join our [Slack workspace](https://join.slack.com/t/hyperswitch-io/shared_invite/zt-1k6cz4lee-SAJzhz6bjmpp4jZCDOtOIg). +- Ask and explore our [GitHub Discussions](https://github.com/juspay/hyperswitch/discussions).
- + Hyperswitch - Fast, reliable, and affordable open source payments switch | Product Hunt
@@ -307,17 +294,14 @@ Get updates on Hyperswitch development and chat with the community:
-

🐞 Bugs and feature requests

+

:lady_beetle: Bugs and feature requests

 -Please read the issue guidelines and search for [existing and closed issues]. -If your problem or idea is not addressed yet, please [open a new issue]. - -[existing and closed issues]: https://github.com/juspay/hyperswitch/issues -[open a new issue]: https://github.com/juspay/hyperswitch/issues/new/choose +Please read the issue guidelines and search for [existing and closed issues](https://github.com/juspay/hyperswitch/issues). +If your problem or idea is not addressed yet, please [open a new issue](https://github.com/juspay/hyperswitch/issues/new/choose). -

πŸ”– Versioning

+

:ticket: Versioning

 Check the [CHANGELOG.md](./CHANGELOG.md) file for details. @@ -330,11 +314,11 @@ This product is licensed under the [Apache 2.0 License](LICENSE). -

✨ Thanks to all contributors

+

:sparkles: Thanks to all contributors

 -Thank you for your support in hyperswitch's growth. Keep up the great work! πŸ₯‚ +Thank you for your support in hyperswitch's growth. Keep up the great work! :clinking_glasses: - Contributors + Contributors to Hyperswitch