@comparaonline/comparanent-ui

Comparanent-UI

React UI Component Library for Compara
based on TSDX

Table of Contents

• Usage
  • Installation
  • Component
• Contributing
• Changelog

Usage

Installation

Comparanent-UI is available as an npm package

// with npm
npm install @comparaonline/comparanent-ui

// with yarn
yarn add @comparaonline/comparanent-ui

Component

import React, { FC } from 'react';
import { Demo } from '@comparaonline/comparanent-ui';

export const MyComponent: FC<{}> = () => <Demo>Just a basic demo</Demo>;

Deployment

Deployment is handled automatically based on semantic-release plugin running as a github action.

It is important to note that the feat and fix branches are the ones that generate new releases according to the semantic-release plugin rules.

Contributing

Read the contributing guide to learn about our development process and how to build, test and commit your changes to Comparanent-UI.

Changelog

If you have recently updated, please read the changelog for details of what has changed.