Skip to content

Commit 3855d66

Browse files
authored
Link to docs (#333)
* increase maximum error offset for CI tests We try to detect how long durations took. However there is no nice way to time this in JSDOM. Instead we take snapshots every requestAnimationFrame and when things change we also write down the time. This solution is not ideal and results in false positives (especially on CI environments). However, it is good enough to ensure that the duration is not 0 and not 500. * cleanup README's and link to docs site * remove readme's in favor of doc site This will be easier, so that we don't have to maintain multiple repo's.
1 parent 6722e9e commit 3855d66

File tree

25 files changed

+36
-4272
lines changed

25 files changed

+36
-4272
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,25 @@
77
beautifully with Tailwind CSS.
88
</p>
99

10+
---
11+
12+
## Documentation
13+
14+
For full documentation, visit [headlessui.dev](https://headlessui.dev).
15+
1016
## Packages
1117

1218
| Name | Version | Downloads |
1319
| :------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------------------------------------: |
1420
| [`@headlessui/react`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-react) | [![npm version](https://img.shields.io/npm/v/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/react.svg)](https://www.npmjs.com/package/@headlessui/react) |
1521
| [`@headlessui/vue`](https://github.com/tailwindlabs/headlessui/tree/main/packages/%40headlessui-vue) | [![npm version](https://img.shields.io/npm/v/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) | [![npm downloads](https://img.shields.io/npm/dt/@headlessui/vue.svg)](https://www.npmjs.com/package/@headlessui/vue) |
22+
23+
## Community
24+
25+
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
26+
27+
[Discuss Headless UI on GitHub](https://github.com/tailwindlabs/tailwindcss/discussions)
28+
29+
For casual chit-chat with others using the library:
30+
31+
[Join the Tailwind CSS Discord Server](https://discord.gg/7NF8GNe)

packages/@headlessui-react/README.md

Lines changed: 8 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<p align="center">
1111
<a href="https://www.npmjs.com/package/@headlessui/react"><img src="https://img.shields.io/npm/dt/@headlessui/react.svg" alt="Total Downloads"></a>
1212
<a href="https://github.com/tailwindlabs/headlessui/releases"><img src="https://img.shields.io/npm/v/@headlessui/react.svg" alt="Latest Release"></a>
13-
<a href="https://github.com/tailwindlabs/headlessui/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/@headlessui/react.svg" alt="License"></a>
13+
<a href="https://github.com/tailwindlabs/headlessui/blob/main/LICENSE"><img src="https://img.shields.io/npm/l/@headlessui/react.svg" alt="License"></a>
1414
</p>
1515

1616
## Installation
@@ -23,30 +23,17 @@ npm install @headlessui/react
2323
yarn add @headlessui/react
2424
```
2525

26-
## Components
26+
## Documentation
2727

28-
_This project is still in early development. New components will be added regularly over the coming months._
28+
For full documentation, visit [headlessui.dev](https://headlessui.dev/react).
2929

30-
- [Transition](./src/components/transitions/README.md)
31-
- [Menu Button (Dropdown)](./src/components/menu/README.md)
32-
- [Listbox (Select)](./src/components/listbox/README.md)
33-
- [Switch (Toggle)](./src/components/switch/README.md)
34-
- [Disclosure](./src/components/disclosure/README.md)
35-
- [FocusTrap](./src/components/focus-trap/README.md)
36-
- [Portal](./src/components/portal/README.md)
37-
- [Dialog](./src/components/dialog/README.md)
38-
- [Popover](./src/components/popover/README.md)
39-
- [Radio Group](./src/components/radio-group/README.md)
30+
## Community
4031

41-
### Roadmap
32+
For help, discussion about best practices, or any other conversation that would benefit from being searchable:
4233

43-
This project is still in early development, but the plan is to build out all of the primitives we need to provide interactive React examples of all of the components included in [Tailwind UI](https://tailwindui.com), the commercial component directory that helps us fund the development of our open-source work like [Tailwind CSS](https://tailwindcss.com).
34+
[Discuss Headless UI on GitHub](https://github.com/tailwindlabs/tailwindcss/discussions)
4435

45-
This includes things like:
36+
For casual chit-chat with others using the library:
4637

47-
- Tabs
48-
- Accordions
38+
[Join the Tailwind CSS Discord Server](https://discord.gg/7NF8GNe)
4939

50-
...and more in the future.
51-
52-
We'll be continuing to develop new components on an on-going basis, with a goal of reaching a pretty fleshed out v1.0 by the end of the year.

packages/@headlessui-react/src/components/dialog/README.md

Lines changed: 0 additions & 155 deletions
This file was deleted.

packages/@headlessui-react/src/components/disclosure/README.md

Lines changed: 0 additions & 81 deletions
This file was deleted.

packages/@headlessui-react/src/components/focus-trap/README.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

0 commit comments

Comments
 (0)