Skip to content

Commit a30fe6a

Browse files
update readme
1 parent 3190552 commit a30fe6a

File tree

2 files changed

+11
-20
lines changed

2 files changed

+11
-20
lines changed

CONTRIBUTING.md

Lines changed: 9 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,11 @@ Welcome to the contributing guidelines! Here you can find instructions on how to
44

55
## The Project Structure
66

7-
The project uses [pnpm](https://pnpm.io/) and [pnpm workspaces](https://pnpm.io/workspaces) and is split into:
7+
The project uses [pnpm](https://pnpm.io/) and comprises:
88

9-
- **packages/docs** which uses [Astro](https://astro.build/) for the documentation
10-
- **packages/lib** is the code for the Svelte-HeadlessUI library
9+
- **src/docs** contains the documentation in Markdown format
10+
- **src/routes** are examples of the components in use
11+
- **src/lib** is the code for the Svelte-HeadlessUI library
1112

1213
## Setting Up The Project
1314

@@ -17,28 +18,18 @@ From the root of the project install the project dependencies.
1718
pnpm install
1819
```
1920

20-
Build the packages in every project of a workspace.
21+
Build the project.
2122

2223
```shell
23-
pnpm -r build
24+
pnpm build
2425
```
2526

26-
## Contributing To The Documentation
27-
28-
From the root of the project navigate to `packages/docs` and run the development server.
29-
30-
```shell
31-
cd packages/docs && pnpm run dev
32-
```
33-
34-
You can open [http://localhost:3000/svelte-headlessui/](http://localhost:3000/svelte-headlessui/) in your browser to see the documentation and make changes.
35-
3627
## Contributing To Svelte-HeadlessUI
3728

38-
From the root of the project navigate to `package/lib` and run the development server.
29+
From the root of the project run the development server.
3930

4031
```shell
41-
cd packages/lib && pnpm run dev
32+
pnpm dev
4233
```
4334

44-
You can open [http://localhost:5173/](http://localhost:5173/) in your browser to see the UI components and make changes.
35+
You can open [http://localhost:5173/](http://localhost:5173/) in your browser to see the UI components and make changes to the components, the documentation, or the examples.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ But also:
1919

2020
## BREAKING CHANGE (v0.0.39)
2121

22-
The latest 0.0.39 release switches to using "change" instead of "select" as the event fired when the selected item changes for semantic correctness and to better match native inputs. Be sure to change listeners from `on:select` to `on:change`!
22+
The 0.0.39 release switched to using "change" instead of "select" as the event fired when the selected item changes for semantic correctness and to better match native inputs. Be sure to change listeners from `onselect` to `onchange`!
2323

2424
## Installation
2525

@@ -37,4 +37,4 @@ You may be interested in evaluating [@rgossiaux/svelte-headlessui](https://svelt
3737

3838
## Logo
3939

40-
Special thanks to [Shoob](https://github.com/hshoob) for the logo!
40+
Special thanks to [Shoob](https://github.com/hshoob) for the awesome logo!

0 commit comments

Comments
 (0)