Skip to content

Commit 80326b1

Browse files
committed
docs: update "Getting Started"
1 parent 3191c51 commit 80326b1

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

docs/getting-started.md

+12
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,15 @@ draggy({
3434
target: ".container",
3535
});
3636
```
37+
38+
### What does this do?
39+
40+
What this does is initialize Draggy on all elements with the class `.container`. This means that all children of `.container` will be draggable, and can be dropped on other `.container` elements if there are more than one. If only one `.container` element is found, the children can be dragged and dropped in the same container.
41+
42+
## Next Steps
43+
44+
You can customize Draggy to fit your needs. You can read more about the options available [here](./options.md). If you want to see some examples, you can find them in the sidebar under "Examples".
45+
46+
For example, you can integrate with [Vue](./examples/vue.md) or [React](./examples/react.md). Or, create a custom shadow element with [this example](./examples/custom-shadow.md).
47+
48+
If you have any questions, feel free to ask in the [Discussions](https://github.com/sebkolind/draggy/discussions) or open an [Issue](https://github.com/sebkolind/draggy/issues).

0 commit comments

Comments
 (0)