Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
CaptainCodeman committed Jan 26, 2025
1 parent 3190552 commit a30fe6a
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 20 deletions.
27 changes: 9 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@ Welcome to the contributing guidelines! Here you can find instructions on how to

## The Project Structure

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

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

## Setting Up The Project

Expand All @@ -17,28 +18,18 @@ From the root of the project install the project dependencies.
pnpm install
```

Build the packages in every project of a workspace.
Build the project.

```shell
pnpm -r build
pnpm build
```

## Contributing To The Documentation

From the root of the project navigate to `packages/docs` and run the development server.

```shell
cd packages/docs && pnpm run dev
```

You can open [http://localhost:3000/svelte-headlessui/](http://localhost:3000/svelte-headlessui/) in your browser to see the documentation and make changes.

## Contributing To Svelte-HeadlessUI

From the root of the project navigate to `package/lib` and run the development server.
From the root of the project run the development server.

```shell
cd packages/lib && pnpm run dev
pnpm dev
```

You can open [http://localhost:5173/](http://localhost:5173/) in your browser to see the UI components and make changes.
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.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ But also:

## BREAKING CHANGE (v0.0.39)

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`!
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`!

## Installation

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

## Logo

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

0 comments on commit a30fe6a

Please sign in to comment.