Smores React

smores-react is a collection of React components that conform to Marshmallow's Design System - "S'mores".

Smores React

smores-react is a collection of React
components that conform to Marshmallow's Design System - "S'mores".

Install

$ yarn add @mrshmllw/smores-react
# OR
$ npm install @mrshmllw/smores-react

Release

1. Checkout the `Master` branch, update Changelog and _bump_ the project version.
> $ git checkout master
> $ git pull
> Be sure that CHANGELOG.md is updated according to [keepachangelog.com](https://keepachangelog.com/en/1.0.0/) with the latest release notes. If not, do it in a separate branch before bumping npm version.
> $ npm version [major | minor | patch] according to [semver.org](https://semver.org/)
> $ git push && git push --tags
> ! check build is successful (green tick in GitHub Actions workflow) before next step

2. Login to NPM.
> $ npm login
> enter your username and password
> enter your email address
> complete two factor authentication

3. Publish to NPM.
> $ npm publish

Usage

import React from 'react';
import {Text, Button} from '@mrshmllw/smores-react';

const App = () => (
  <>
    <Text>Hey you</Text>
    <Button
      color="green"
      onClick={() => console.log('thanks for clicking :)')}
    >
      Click me!
    </Button>
  </>
);