Skip to content

Latest commit

 

History

History
65 lines (46 loc) · 1.97 KB

README.md

File metadata and controls

65 lines (46 loc) · 1.97 KB
Raw

Tailor UI

npm CircleCI style: styled-components Netlify Status

Documentation

Check out our documentation website.

Installation

# with npm
npm install tailor-ui

# with yarn
yarn add tailor-ui

Usage

Here is a quick example to get you started, it's all you need:

import React from 'react';
import ReactDOM from 'react-dom';
import { Button, UIProvider } from 'tailor-ui';

const App = () => (
  <UIProvider>
    <Button>Hello World</Button>
  </UIProvider>
);

ReactDOM.render(<App />, document.querySelector('#root'));

Development

git clone [email protected]:Yoctol/tailor-ui.git

First, open the terminal to watch the file changing and do the type checking:

cd tailor-ui
yarn watch

And then, open another tab to run the project:

cd tailor-ui
yarn start

Release

  • Send PR to develop branch during development.
  • When you want to release the version, merge develop branch into master branch, and then sematic release will automatically release new version on CI.
    • Make sure Environment Variables on CircleCI are setup correctly. GH_TOKEN need to have repo scope and NPM_TOKEN need to have access to tailor-ui package.
  • After new version released, merge master back to develop.