From 66aba5d83a648d4081008c5550c372b3b4ca90e2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20DOUIN?= Date: Tue, 7 Jan 2025 14:32:42 +0100 Subject: [PATCH] docs(readme): fix test badge typo, reword features section --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 500aa1e..a51ead2 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# 📟 React PIN Field [![tests](https://img.shields.io/github/actions/workflow/status/soywod/react-pin-field/tests.yml?branch=master&label=tests&logo=github)](https://github.com/soywod/react-pin-field/actions/workflows/test.yml) [![codecov](https://img.shields.io/codecov/c/github/soywod/react-pin-field?logo=codecov)](https://app.codecov.io/gh/soywod/react-pin-field) [![npm](https://img.shields.io/npm/v/react-pin-field?logo=npm&label=npm&color=success)](https://www.npmjs.com/package/react-pin-field) +# 📟 React PIN Field [![tests](https://img.shields.io/github/actions/workflow/status/soywod/react-pin-field/tests.yml?branch=master&label=tests&logo=github)](https://github.com/soywod/react-pin-field/actions/workflows/tests.yml) [![codecov](https://img.shields.io/codecov/c/github/soywod/react-pin-field?logo=codecov)](https://app.codecov.io/gh/soywod/react-pin-field) [![npm](https://img.shields.io/npm/v/react-pin-field?logo=npm&label=npm&color=success)](https://www.npmjs.com/package/react-pin-field) React component for entering PIN codes @@ -9,11 +9,11 @@ React component for entering PIN codes ## Features - Written in TypeScript, tested with Jest and Cypress -- Relies on `onchange` native event to improve browsers compatibility +- Relies on `onchange` native event with minimum interaction for better browser compatibility - Supports HTML [`dir`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/dir) left-to-right and right-to-left - Supports HTML [`autofocus`](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus) by focusing either the first or the last input, depending on `dir` - Supports [ARIA](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA) attributes like `aria-required`, `aria-label`… -- Works well with [key composition](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event) +- Supports [key composition](https://developer.mozilla.org/en-US/docs/Web/API/Element/compositionstart_event) ## Installation