Skip to content

chore: update README #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
nrigaudiere merged 1 commit into from
Apr 27, 2026
Merged

chore: update README #18

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,25 +53,41 @@ See [benchmark details](https://github.com/lightpanda-io/demo)._

This repository contains all the [NPM](https://npmjs.com) packages created for Lightpanda

### Development mode

```
$ yarn dev
```

### Lint

_using [Biome](https://biomejs.dev/)_

```
$ yarn lint
```

### Build

```
$ yarn build
```

### Publish
To publish packages, we use [changesets](https://github.com/changesets/changesets). Make sure to have commited & pushed all your code before publishing.
## Publish
To publish packages, we use [Changesets](https://github.com/changesets/changesets). Make sure to have committed & pushed all your code before publishing.

1. Run the following command to create a new version (patch, minor, major)

```
$ yarn changeset add
```

2. Publish all the packages
2. Push Changeset commit to your branch

3. Publish all the packages

```
$ yarn publish-packages
```

3. Push the new commits & merge to main
4. Push release commits & merge to main
Loading