# @rocketsoftware/carbon-components

> Rocket Software's open source design system based on the Carbon Design System
> by IBM.

## Getting started

To install `@rocketsoftware/carbon-components` in your project, you will need to
run the following command using [npm](https://www.npmjs.com/):

```bash
npm install -S @rocketsoftware/carbon-components
```

If you prefer [Yarn](https://yarnpkg.com/en/), use the following command
instead:

```bash
yarn add @rocketsoftware/carbon-components
```

## 📖 API Documentation

If you're looking for `@rocketsoftware/carbon-components` API documentation,
check out:

- [Accessibility](./docs/accessibility.md)
- [Deploying-changes](./docs/deploying-changes.md)
- [Experimental](./docs/experimental.md)
- [G11n](./docs/g11n.md)
- [Migration](./docs/migration)
- [Sass](./docs/sass.md)
- [Vendor-styles](./docs/vendor-styles.md)

## 🙌 Contributing

We're always looking for contributors to help us fix bugs, build new features,
or help us improve the project documentation. If you're interested, definitely
check out our [Contributing Guide](/.github/CONTRIBUTING.md)! 👀

## 📝 License

Licensed under the [Apache 2.0 License](/LICENSE).