diff --git a/packages/snapshot-tests/README.md b/packages/snapshot-tests/README.md index 6b2b9f2d84..2c39654674 100644 --- a/packages/snapshot-tests/README.md +++ b/packages/snapshot-tests/README.md @@ -1 +1,106 @@ -# Package with snapshot test suits for testing themes for RJSF +[![Build Status][build-shield]][build-url] +[![npm][npm-shield]][npm-url] +[![npm downloads][npm-dl-shield]][npm-dl-url] +[![Contributors][contributors-shield]][contributors-url] +[![Apache 2.0 License][license-shield]][license-url] + +
+

+ + Logo + + +

@rjsf/snapshot-tests

+ +

+ Core logic and classic Bootstrap 3 theme for react-jsonschema-form. +
+ Explore the docs » +
+
+ View Playground + · + Report Bug + · + Request Feature +

+

+ + + +## Table of Contents + +- [Table of Contents](#table-of-contents) +- [About The Project](#about-the-project) + - [Built With](#built-with) +- [Getting Started](#getting-started) + - [Prerequisites](#prerequisites) + - [Installation](#installation) +- [Usage](#usage) +- [Roadmap](#roadmap) +- [Contributing](#contributing) +- [Contact](#contact) + + + +## About The Project + +Package with snapshot test suits for testing themes for `react-jsonschema-form`. + + + +## Getting Started + +### Installation + +```sh +npm install @rjsf/snapshot-tests +``` + +## Usage + +```tsx +import { arrayTests } from '@rjsf/snapshot-tests'; // OR +// import { formTests } from '@rjsf/snapshot-tests'; +// import { objectTests } from '@rjsf/snapshot-tests'; + +import Form from '../src'; + +arrayTests(Form); // OR +// formTests(Form); +// objectTests(Form); +``` + + +## Roadmap + +See the general [open issues](https://github.com/rjsf-team/react-jsonschema-form/issues). + + + +## Contributing + +Read our [contributors' guide](https://rjsf-team.github.io/react-jsonschema-form/docs/contributing/) to get started. + + + +## Contact + +rjsf team: [https://github.com/orgs/rjsf-team/people](https://github.com/orgs/rjsf-team/people) + +GitHub repository: [https://github.com/rjsf-team/react-jsonschema-form](https://github.com/rjsf-team/react-jsonschema-form) + + + + +[build-shield]: https://github.com/rjsf-team/react-jsonschema-form/workflows/CI/badge.svg +[build-url]: https://github.com/rjsf-team/react-jsonschema-form/actions +[contributors-shield]: https://img.shields.io/github/contributors/rjsf-team/react-jsonschema-form.svg +[contributors-url]: https://github.com/rjsf-team/react-jsonschema-form/graphs/contributors +[license-shield]: https://img.shields.io/badge/license-Apache%202.0-blue.svg?style=flat-square +[license-url]: https://choosealicense.com/licenses/apache-2.0/ +[npm-shield]: https://img.shields.io/npm/v/@rjsf/snapshot-tests/latest.svg?style=flat-square +[npm-url]: https://www.npmjs.com/package/@rjsf/snapshot-tests +[npm-dl-shield]: https://img.shields.io/npm/dm/@rjsf/snapshot-tests.svg?style=flat-square +[npm-dl-url]: https://www.npmjs.com/package/@rjsf/snapshot-tests +[product-screenshot]: https://raw.githubusercontent.com/rjsf-team/react-jsonschema-form/59a8206e148474bea854bbb004f624143fbcbac8/packages/snapshot-tests/screenshot.png