# prettier-config-carbon

> Prettier config for the Carbon Design System

## Getting started

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

```bash
npm install -S prettier-config-carbon
```

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

```bash
yarn add prettier-config-carbon
```

## Usage

You can use this prettier configuration by creating a `prettier.config.js` file
in the root of project and using this package in the following way:

```js
'use strict';

const prettierConfig = require('prettier-config-carbon');
module.exports = prettierConfig;
```

## 🙌 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).