@carbon/ibm-security/README.md

Carbon for Cloud & Cognitive IBM Security UI components

# @carbon/ibm-security

> Carbon for IBM Products - Security UI components

## Getting started

> **Note:** This package on NPM was previously sourced from a repository that is
> no longer maintained. To ensure you are using the code that is being
> maintained, please check your version of `@carbon/ibm-security` in your
> package.json and lock file. If the version is 2.x, you are using code from
> this repo.

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

```bash
npm i @carbon/ibm-security
```

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

```bash
yarn add @carbon/ibm-security
```

Also refer to
[getting started in Carbon for IBM Security](https://github.com/carbon-design-system/ibm-security#react).

## 🙌 Contributing

**Note:** `packages/security/src` is currently synced periodically with
[`carbon-design-system/ibm-security/tree/dev/src`](https://github.com/carbon-design-system/ibm-security/tree/dev/src)
and changes to this directory will be overwritten.

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](https://github.com/carbon-design-system/ibm-products/blob/master/.github/CONTRIBUTING.md)
and
[Carbon's Developer Handbook](https://github.com/carbon-design-system/carbon/blob/master/docs/developer-handbook.md)!
👀

## <picture><source height="20" width="20" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-dark.svg"><source height="20" width="20" media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"><img height="20" width="20" alt="IBM Telemetry" src="https://raw.githubusercontent.com/ibm-telemetry/telemetry-js/main/docs/images/ibm-telemetry-light.svg"></picture> IBM Telemetry

This package uses IBM Telemetry to collect de-identified and anonymized metrics
data. By installing this package as a dependency you are agreeing to telemetry
collection. To opt out, see
[Opting out of IBM Telemetry data collection](https://github.com/ibm-telemetry/telemetry-js/tree/main#opting-out-of-ibm-telemetry-data-collection).
For more information on the data being collected, please see the
[IBM Telemetry documentation](https://github.com/ibm-telemetry/telemetry-js/tree/main#ibm-telemetry-collection-basics).

## 📝 License

Licensed under the
[Apache-2.0 License](https://github.com/carbon-design-system/ibm-products/blob/master/LICENSE).