diff --git a/.gitignore b/.gitignore index 59d4885..f011788 100644 --- a/.gitignore +++ b/.gitignore @@ -3,6 +3,3 @@ lib/ react-table.js react-table.css *.log -example/dist/ - -storybook-static diff --git a/README.md b/README.md index 2b77c6a..5a757bb 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,8 @@ - - + + @@ -391,17 +391,19 @@ To suggest a feature, create an issue if it does not already exist. If you would like to help develop a suggested feature follow these steps: - Fork this repo -- `npm install` -- `npm run watch` +- `$ yarn` +- `$ yarn run storybook` - Implement your changes to files in the `src/` directory +- View changes as you code via our React Storybook `localhost:8000` +- Make changes to stories in `/stories`, or create a new one if needed - Submit PR for review -If you would like to preview your changes as you develop, you can link and utilize our React Storybook like so: +#### Scripts -- `npm install` -- `run storybook` (or run them in separate tabs) -- Make changes to stories in `/stories`, or create a new one if needed -- View changes at `localhost:8000` +- `$ yarn run storybook` Runs the storybook server +- `$ yarn run test` Runs the test suite +- `$ yarn run prepublish` Builds the distributable bundle +- `$ yarn run docs` Builds the website/docs from the storybook for github pages ## Used By