From 888a0391c5817b25244efd9dc8fae1d54f6ce23a Mon Sep 17 00:00:00 2001
From: sj <suresh@robotpajamas.com>
Date: Wed, 4 Dec 2024 12:04:44 -0500
Subject: [PATCH] Updated Readme

---
 README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 45 insertions(+)

diff --git a/README.md b/README.md
index 014f42f..00cfa85 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,50 @@
 # headlessui-svelte
 
+This is an alpha port of [HeadlessUI](https://headlessui.com/) targeting Svelte 5 (or later).
+
+A primary design goal is to stay as reasonably faithful to the HeadlessUI-React API as possible, in order to integrate better with [TailwindUI](https://tailwindui.com/). A secondary design goal is to align folder naming and tests, in order to reduce cognitive burden when porting and making updates.
+
+This can manifest in strange, but intentional, ways:
+- the existence of a `hooks` folder (not [SvelteKit hooks](https://svelte.dev/docs/kit/hooks))
+- using test functions from the main headlessui repo, instead of the equivalent `testing-library` functionality
+- the existence of a `Fragment` component
+- ...
+
+## Progress
+
+### Forms
+
+- [ ] Button
+- [ ] Checkbox
+- [ ] Combobox
+- [ ] Description
+- [ ] Field
+- [ ] Fieldset
+- [ ] Input
+- [ ] Label
+- [ ] Listbox
+- [ ] Radio Group
+- [ ] Select
+- [ ] Switch
+- [ ] Textarea
+
+### Components
+
+- [ ] Dropdown Menu
+- [ ] Disclosure
+- [ ] Dialog
+- [ ] Popover
+- [ ] Portal
+- [ ] Tabs
+- [ ] Transition
+
+## Community
+
+Other Svelte-based HeadlessUI implementations:
+
+- CaptainCodeman: https://github.com/CaptainCodeman/svelte-headlessui
+- rgossiaux: https://github.com/rgossiaux/svelte-headlessui
+
 ## License
 
 This library is licensed under the MIT license; see the LICENSE file for more.