Add component documentation.

jhubbardsf · May 5, 2022 · ce8a290 · ce8a290
1 parent d381d41
commit ce8a290
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "@jhubbardsf/svelte-sortablejs",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"author": "Josh Hubbard <[email protected]> (https://joshuahubbard.dev/)",
 	"description": "A Svelte wrapper for the Sortable.js library",
 	"repository": {

diff --git a/src/lib/SortableList.svelte b/src/lib/SortableList.svelte
@@ -264,6 +264,20 @@
 	});
 </script>
 
+<!--
+@component
+Svelte wrapper for SortableJS.
+
+- Usage:
+  ```tsx
+  <SortableList>
+	<div>List Item 1</div>
+	<div>List Item 2</div>
+	<div>List Item 3</div>
+  </SortableList>
+	```
+  -->
+
 <div bind:this={list} class={className}>
 	<slot />
 </div>