transcend-react/README.md

Transcend-react is a component library for NUVI

[![npm Version](https://img.shields.io/npm/v/transcend-react.svg)](https://www.npmjs.com/package/transcend-react) [![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release) [![CircleCI build](https://circleci.com/gh/nuvi/transcend-react.svg?style=shield&circle-token=db4ca270036e7359d5dbda5cc03ba1bed54f1d01)](https://circleci.com/gh/nuvi/transcend-react)

# transcend-react
WARNING - This library is DEPRECATED. Don't add to it unless it has to do with integration or transition away from it!!!



React components and whatnot that transcend multiple projects. See also [transcend-static-assets](https://github.com/nuvi/transcend-static-assets).

## Developing locally

### Using Storybook

`transcend-react` is using [Storybook](https://storybook.js.org/) for component library docs:

```
npm install
npm run storybook
```

### As part of an application

As of `transcend-react@4`, applications can use local installations by referencing a local file path in `package.json`:

```
cd gavin
npm rm transcend-react && npm i <local path to>/transcend-react
```


## Releasing a new version of transcend-react

Releasing the `transcend-react` package to the npm registry is now handled automatically via CI when you merge to master, via [semantic-release](https://github.com/semantic-release/semantic-release). The new semantic version will be calculated automatically, **so long as you format your commit messages appropriately.** This can be done easily by running `npm run commit` instead of `git commit`, and filling out the prompts (your formatted commit message will be generated automatically).