Skip to content

Commit 7e6c25b

Browse files
committed
Updated README
1 parent 97b18f1 commit 7e6c25b

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

Diff for: README.md

+16-1
Original file line numberDiff line numberDiff line change
@@ -147,4 +147,19 @@ Event Name | Listener Arguments | Event Description
147147
Returns a RxJS observable that streams all of Dragster's events.
148148

149149
### `destroy(): void`
150-
Removes all drag and drop events used by Dragster to manage drag and drop between the containers. If `destroy()` is called while an element is being dragged, the drag will be effectively cancelled.
150+
Removes all drag and drop events used by Dragster to manage drag and drop between the containers. If `destroy()` is called while an element is being dragged, the drag will be effectively cancelled.
151+
152+
## Replacing Dragula with Dragster
153+
154+
To replace dragula with Dragster, just remove dragula's JS and CSS files and add `docs/dragster.min.js`. If you are using npm, add Dragster using:
155+
156+
`npm install --save dragster.js`
157+
158+
Dragster will work out-of-the-box, since it interfaces dragula. Therefore, your existing `dragula()` calls will work as-is.
159+
160+
```typescript
161+
import {dragula} from 'dragster.js';
162+
163+
// drake will be instanceof Dragster
164+
let drake = dragula([document.getElementById('left'), document.getElementById('right')]);
165+
```

0 commit comments

Comments
 (0)