# @sumup-oss/circuit-ui [![Stars](https://img.shields.io/github/stars/sumup-oss/circuit-ui?style=social)](https://github.com/sumup-oss/circuit-ui/) [![Version](https://img.shields.io/npm/v/@sumup-oss/circuit-ui)](https://www.npmjs.com/package/@sumup-oss/circuit-ui) [![Coverage](https://img.shields.io/codecov/c/github/sumup-oss/circuit-ui)](https://codecov.io/gh/sumup-oss/circuit-ui) [![License](https://img.shields.io/github/license/sumup-oss/circuit-ui)](https://github.com/sumup-oss/circuit-ui/tree/main/packages/circuit-ui/LICENSE) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.1%20adopted-ff69b4.svg)](https://github.com/sumup-oss/circuit-ui/tree/main/CODE_OF_CONDUCT.md) A React component library designed to help developers build inclusive, performant, and trusted user interfaces.
## Installation Depending on your preference, run one of the following in your terminal: ```sh # With npm npm install --save @sumup-oss/circuit-ui # With yarn v1 yarn add @sumup-oss/circuit-ui ``` `@sumup-oss/circuit-ui` has a number of required peer dependencies. If your project doesn't have them already, you can install them by running: ```sh # With npm npm install --save react react-dom @sumup-oss/design-tokens @sumup-oss/icons @sumup-oss/intl # With yarn v1 yarn add react react-dom @sumup-oss/design-tokens @sumup-oss/icons @sumup-oss/intl ``` ## Usage Here are a few helpful links for getting started with Circuit UI: - [Documentation](https://circuit.sumup.com/) - Learn how to use Circuit UI and view the components in Storybook. - [Getting started](https://circuit.sumup.com/?path=/docs/introduction-getting-started--docs) - Set up a new app with Circuit UI or add it to an existing project. - [Theming](https://circuit.sumup.com/?path=/docs/features-theme--docs) - Learn about our foundations such as colors, spacing, and typography. - [Contribute](https://circuit.sumup.com/?path=/docs/contributing-overview--docs) - File a bug report, suggest a change, or open a pull request.