diff --git a/README.md b/README.md index 5098694..221c074 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,56 @@ # react-bootstrap-table2 + [![Build Status](https://travis-ci.org/react-bootstrap-table/react-bootstrap-table2.svg?branch=master)](https://travis-ci.org/react-bootstrap-table/react-bootstrap-table2) -Rebuilt [react-bootstrap-table](https://github.com/AllenFang/react-bootstrap-table) +Rebuilt of [react-bootstrap-table](https://github.com/AllenFang/react-bootstrap-table) -> `react-bootstrap-table2`'s npm module name is [**`react-bootstrap-table-next`**](https://www.npmjs.com/package/react-bootstrap-table-next) due to some guys already used it +> Note that `react-bootstrap-table2`'s npm module name is [**`react-bootstrap-table-next`**](https://www.npmjs.com/package/react-bootstrap-table-next) due to the name being already taken. -`react-bootstrap-table2` separate some functionalities from core modules to other modules like following: +`react-bootstrap-table2` separates some functionalities from its core modules to other modules as listed in the following: -* [`react-bootstrap-table-next`](https://www.npmjs.com/package/react-bootstrap-table-next) -* [`react-bootstrap-table2-filter`](https://www.npmjs.com/package/react-bootstrap-table2-filter) -* [`react-bootstrap-table2-editor`](https://www.npmjs.com/package/react-bootstrap-table2-editor) -* [`react-bootstrap-table2-paginator`](https://www.npmjs.com/package/react-bootstrap-table2-paginator) -* [`react-bootstrap-table2-overlay`](https://www.npmjs.com/package/react-bootstrap-table2-overlay) -* [`react-bootstrap-table2-toolkit`](https://www.npmjs.com/package/react-bootstrap-table2-toolkit) +- [`react-bootstrap-table-next`](https://www.npmjs.com/package/react-bootstrap-table-next) +- [`react-bootstrap-table2-filter`](https://www.npmjs.com/package/react-bootstrap-table2-filter) +- [`react-bootstrap-table2-editor`](https://www.npmjs.com/package/react-bootstrap-table2-editor) +- [`react-bootstrap-table2-paginator`](https://www.npmjs.com/package/react-bootstrap-table2-paginator) +- [`react-bootstrap-table2-overlay`](https://www.npmjs.com/package/react-bootstrap-table2-overlay) +- [`react-bootstrap-table2-toolkit`](https://www.npmjs.com/package/react-bootstrap-table2-toolkit) -This can help your application with less bundled size and also help us have clean design to avoid handling to much logic in kernel module(SRP). +Not only does this reduce the bundle size of your apps but also helps us have a cleaner design to avoid handling too much logic in the kernel module(SRP). ## Migration -If you are the user from legacy [`react-bootstrap-table`](https://github.com/AllenFang/react-bootstrap-table/), please have a look on [this](./docs/migration.md). + +If you are coming from the legacy [`react-bootstrap-table`](https://github.com/AllenFang/react-bootstrap-table/), please check out the [migration guide](./docs/migration.md). ## Usage + See [getting started](https://react-bootstrap-table.github.io/react-bootstrap-table2/docs/getting-started.html). ## Online Demo + See `react-bootstrap-table2` [storybook](https://react-bootstrap-table.github.io/react-bootstrap-table2/storybook/index.html). ## Roadmap + See [release plans](https://react-bootstrap-table.github.io/react-bootstrap-table2/blog/2018/01/24/release-plan.html). ## Development -Please check [development guide](./docs/development.md). -## How should I run storybook example in my local? +Please check the [development guide](./docs/development.md). + +## Running storybook example on your local machine ```sh +# Clone the repo $ git clone https://github.com/react-bootstrap-table/react-bootstrap-table2.git + +# change dir to the cloned repo $ cd react-bootstrap-table2 + +# Install all dependencies with yarn $ yarn install + +# Start the stroybook server, then go to localhost:6006 $ yarn storybook -$ Go to localhost:6006 + ``` **Storybook examples: [`packages/react-bootstrap-table2-example/examples`](https://github.com/react-bootstrap-table/react-bootstrap-table2/tree/master/packages/react-bootstrap-table2-example/examples)**