Website with demo table using shadcn-svelte

.github/workflows/check.yml

@@ -17,5 +17,8 @@ jobs:
       - name: Install dependencies
         run: npm ci
 
-      - name: Lint and svelte-check
+      - name: svelte-check
         run: npm run check
+
+      - name: Unit tests
+        run: npm test

.npmrc

@@ -1 +1,2 @@
 engine-strict=true
+legacy-peer-deps=true

.prettierrc

@@ -3,6 +3,6 @@
 	"singleQuote": true,
 	"trailingComma": "none",
 	"printWidth": 100,
-	"plugins": ["prettier-plugin-svelte"],
+	"plugins": ["prettier-plugin-svelte", "prettier-plugin-tailwindcss"],
 	"overrides": [{ "files": "*.svelte", "options": { "parser": "svelte" } }]
 }

README.md

@@ -1,11 +1,33 @@
-<h1 align="center">@careswitch/svelte-data-table</h1>
+<h1 align="center">svelte-data-table</h1>
 
-<p align="center">Simple data table library with client-side sorting, filtering, and pagination.</p>
+<p align="center">Small, fast data table library with client-side sorting, filtering, and pagination.</p>
 
 - No dependencies
 - TypeScript
-- SvelteKit, SSR, and Svelte 5 Runes
+- Supports SvelteKit, SSR, Svelte 5
 
-## Quickstart
+## Installation
 
-`npm install @careswitch/svelte-data-table`
+```bash
+npm install @careswitch/svelte-data-table
+```
+
+## Usage
+
+```svelte
+<script lang="ts">
+	import { DataTable } from '@careswitch/svelte-data-table';
+
+	const table = new DataTable({
+		data: [
+			{ id: 1, name: 'John Doe', status: 'active' },
+			{ id: 2, name: 'Jane Doe', status: 'inactive' }
+		],
+		columns: [
+			{ key: 'id', name: 'ID' },
+			{ key: 'name', name: 'Name' },
+			{ key: 'status', name: 'Status', sortable: false }
+		]
+	});
+</script>
+```

components.json

@@ -0,0 +1,14 @@
+{
+	"$schema": "https://shadcn-svelte.com/schema.json",
+	"style": "new-york",
+	"tailwind": {
+		"config": "tailwind.config.ts",
+		"css": "src/app.css",
+		"baseColor": "zinc"
+	},
+	"aliases": {
+		"components": "$lib/components",
+		"utils": "$lib/utils"
+	},
+	"typescript": true
+}