README
Clearkit
clearkit-react
Using You'll need to install and import:
clearkit-react
Working on Install Dependencies
Easy peasy!
yarn
Develop Locally
I suggest developing against Storybook, which pulls in src/index.tsx
(the main entry point for the library) and does hot module reloading for you.
yarn storybook
Run the tests with the following incantation, making use of the optional --watch
flag.
yarn test
Publish New Versions
I use the tool np
(which I have installed globally) for deploying new versions of the library.
When you're ready to deploy and your changes are pushed to master, run np
and it will walk you through the various steps –
- Verifying tests pass
- Choosing a new version number
- Auto-tagging and release notes
- Publishing to NPM.