Skip to content

Commit

Permalink
Add current master branch usage to README
Browse files Browse the repository at this point in the history
  • Loading branch information
dapi committed Jul 19, 2019
1 parent 760272b commit ef41861
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ or
$ yarn add react-trello
```


## Usage

The `Board` component takes a prop called `data` that contains all the details related to rendering the board. A sample data json is given here to illustrate the contract:
Expand Down Expand Up @@ -84,6 +85,18 @@ Refer to storybook for detailed examples: https://rcdexta.github.io/react-trello

Also refer to the sample project that uses react-trello as illustration: https://github.com/rcdexta/react-trello-example

## Usage of current master branch

```bash
$ yarn add rcdexta/react-trello
```

and

```javascript
import Board from 'react-trello/src'
```

## Upgrade

Breaking changes. Since version 2.2 these properties are removed: `addLaneTitle`, `addCardLink`, `customLaneHeader`, `newCardTemplate`, `newLaneTemplate`,
Expand Down

0 comments on commit ef41861

Please sign in to comment.