Skip to content

Commit e69291f

Browse files
committed
feat(Release 2.2): Fixing readme and docs for next minor release
1 parent 06aed12 commit e69291f

File tree

1 file changed

+13
-19
lines changed

1 file changed

+13
-19
lines changed

README.md

+13-19
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Pluggable components to add a trello-like kanban board to your application
44

55
[![Build Status](https://travis-ci.org/rcdexta/react-trello.svg?branch=master)](https://travis-ci.org/rcdexta/react-trello)
6-
[![npm version](https://badge.fury.io/js/react-trello.svg)](https://badge.fury.io/js/react-trello)
6+
[![yarn version](https://badge.fury.io/js/react-trello.svg)](https://badge.fury.io/js/react-trello)
77
[![bundlephobia.com](https://img.shields.io/bundlephobia/minzip/react-trello.svg)](https://bundlephobia.com/result?p=react-trello)
88

99
#### Basic Demo
@@ -27,10 +27,10 @@ Pluggable components to add a trello-like kanban board to your application
2727

2828
## Getting Started
2929

30-
Install using npm or yarn
30+
Install using yarn or yarn
3131

3232
```bash
33-
$ npm install --save react-trello
33+
$ yarn install --save react-trello
3434
```
3535

3636
or
@@ -312,12 +312,6 @@ Tested to work with following browsers using [Browserling](https://www.browserli
312312
* Safari 4.0 or above
313313
* Microsoft Edge 15 or above
314314
315-
## Feature Wishlist
316-
317-
* the prop `onDataChange` is a catch all callback that returns the entire board data when anything changes on the board. Micro-events like when a card is added or re-arranged should be possible too
318-
319-
Check the Milestones for this project to track when the above features will be implemented.
320-
321315
## Logging
322316
323317
Pass environment variable `REDUX_LOGGING` as true to enable Redux logging in any environment
@@ -332,16 +326,16 @@ yarn run storybook
332326
333327
### Scripts
334328
335-
1. `npm run lint` : Lint all js files
336-
2. `npm run lintfix` : fix linting errors of all js files
337-
3. `npm run semantic-release` : make a release. Leave it for CI to do.
338-
4. `npm run storybook`: Start developing by using storybook
339-
5. `npm run test` : Run tests. tests file should be written as `*.test.js` and using ES2015
340-
6. `npm run test:watch` : Watch tests while writing
341-
7. `npm run test:cover` : Show coverage report of your tests
342-
8. `npm run test:report` : Report test coverage to codecov.io. Leave this for CI
343-
9. `npm run build`: transpile all ES6 component files into ES5(commonjs) and put it in `dist` directory
344-
10. `npm run docs`: create static build of storybook in `docs` directory that can be used for github pages
329+
1. `yarn run lint` : Lint all js files
330+
2. `yarn run lintfix` : fix linting errors of all js files
331+
3. `yarn run semantic-release` : make a release. Leave it for CI to do.
332+
4. `yarn run storybook`: Start developing by using storybook
333+
5. `yarn run test` : Run tests. tests file should be written as `*.test.js` and using ES2015
334+
6. `yarn run test:watch` : Watch tests while writing
335+
7. `yarn run test:cover` : Show coverage report of your tests
336+
8. `yarn run test:report` : Report test coverage to codecov.io. Leave this for CI
337+
9. `yarn run build`: transpile all ES6 component files into ES5(commonjs) and put it in `dist` directory
338+
10. `yarn run docs`: create static build of storybook in `docs` directory that can be used for github pages
345339
346340
Learn how to write stories [here](https://storybook.js.org/basics/writing-stories/)
347341

0 commit comments

Comments
 (0)