Skip to content

Commit 1686019

Browse files
committed
docs: ensure sortablejs and @types/sortablejs are peers dependencies
BREAKING CHANGE: peer dependencies now required
1 parent 5bdf2c9 commit 1686019

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,17 @@ React bindings to [SortableJS](https://github.com/SortableJS/Sortable)
66

77
## Installation
88

9+
`sortablejs` and `@types/sortbalejs` are peer dependencies. The latter only used if intellisense/typescript is desired.
10+
911
```shell
10-
npm install --save react-sortablejs
12+
npm install --save react-sortablejs sortablejs
13+
npm install --save-dev @types/sortablejs
14+
1115
# OR
12-
yarn add react-sortablejs
16+
yarn add react-sortablejs sortablejs
17+
yarn add -D @types/sortablejs
1318
```
1419

15-
Please note that `sortablejs` is not required, as it's bundled in this component.
16-
1720
## Learn
1821

1922
Here is the TLDR of what sortable is:

0 commit comments

Comments
 (0)