# Centricminds UI

React components and associated utilities for use across Centricminds.

## Requirements

- [Node](https://nodejs.org/en/) version 14 or higher
- [Yarn](https://yarnpkg.com/en/)

## How to use

To import components, add 
```html
<div id="centricmindsUi_{component}"></div>
```
where `{component}` is the name of the component in lower-case. For a list of possible components to add, see TBD.

Add 
```html
<script src="https://cdn.jsdelivr.net/npm/centricminds-ui@{version}/dist/centricminds-ui.umd.js"></script>
```

to the bottom of the page inside the `<body>` tag. Make sure you change `{version}` to the correct version. You can view the [npm package](https://www.npmjs.com/package/centricminds-ui) to see all the version numbers.

## Versioning

Centricminds UI follows [Semantic Versioning](https://semver.org), as well as maintaining a [changelog](https://keepachangelog.com). We rely on [semantic release](https://github.com/semantic-release/github) to handle this for us.

Any new feature additions or changes will bump the project's version number incrementally by 0.1.0 (e.g. 1.2.3 becomes 1.3.0).

Bug fixes will increment the patch version (e.g. 1.2.3 becomes 1.2.4).

Breaking changes will increment the major version (e.g. 1.2.3 becomes 2.0.0).

## Contributing

To contribute to centricminds UI, see [CONTRIBUTING.md](CONTRIBUTING.md).

## Links

- [Production storybook](http://centricminds-ui-sb.s3-website-ap-southeast-2.amazonaws.com)
