Skip to content

Commit

Permalink
fix($browser): Use prop-types for Props validation. Migrate from npm …
Browse files Browse the repository at this point in the history
…to yarn
  • Loading branch information
rcdexta committed May 25, 2017
1 parent 72eebe4 commit f69391f
Show file tree
Hide file tree
Showing 2 changed files with 6,413 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@ See the storybook demo here: https://rcdexta.github.io/react-event-timeline
```
npm install --save react-event-timeline
```
or if you are using `yarn`

```
yarn add react-event-timeline
```

## Usage

Expand Down Expand Up @@ -81,11 +86,11 @@ Each event in the timeline will be represented by the `TimelineEvent` component.
This project recommends using [react-storybook](https://github.com/kadirahq/react-storybook) as a UI component development environment. Use the following scripts for your development workflow:
1. `npm run storybook`: Start developing by using storybook
1. `npm run lint` : Lint all js files
1. `npm run lintfix` : fix linting errors of all js files
1. `npm run build`: transpile all ES6 component files into ES5(commonjs) and put it in `dist` directory
1. `npm run docs`: create static build of storybook in `docs` directory that can be used for github pages
1. `yarn storybook`: Start developing by using storybook
1. `yarn lint` : Lint all js files
1. `yarn lintfix` : fix linting errors of all js files
1. `yarn build`: transpile all ES6 component files into ES5(commonjs) and put it in `dist` directory
1. `yarn docs`: create static build of storybook in `docs` directory that can be used for github pages
The storybook artefacts can be found in `stories` folder. Run `npm run storybook` and you should see your code changes live reloaded on the browser
Expand Down
Loading

0 comments on commit f69391f

Please sign in to comment.