From 8d9bc043bfb32d5197056dcf1dcef36ca6dc45e1 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 9 Apr 2021 16:05:38 +0000 Subject: [PATCH] [skip ci] Update readme --- README.md | 25 ++++++++++++++++++++++++- 1 file changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc276fc..51dca0c 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,6 @@ function Example(){ **Note**: the providers list has no particular sorting order and is shuffled at every page load. - #### Accessibility notes In general using the `POST` version of this component makes it usable for the most wide audience, as the `GET` version uses links which may have issues. To know more read below. @@ -45,6 +44,30 @@ The component tries its best to provide the best a11y practices implemented, but In particular in OSX Safari and Firefox have some issues with `focus` and the behaviour of `tab`: [please read about it](https://github.com/theKashey/react-focus-lock#focusing-in-osx-safarifirefox-is-strange) when using this component. +#### Contributing + +To get up and running with the development of the project you can follow these steps. + +To see the component in action, useful to test it manually after some changes, open a terminal window and type: + +```sh +cd example +npm start +``` + +This will start the `create-react-app` project and open a new browser tab with the example application in it. + +At this point it is possible to perform changes to the component/library, open a new terminal in the project folder and use this command when done with changes: +```sh +npm build +``` + +To run the test do: + +```sh +npm test +``` + # API