Skip to content

Commit

Permalink
adding some readme steps for setup
Browse files Browse the repository at this point in the history
  • Loading branch information
gnomadic committed Jan 19, 2024
1 parent 77d76e4 commit 36e9091
Showing 1 changed file with 32 additions and 1 deletion.
33 changes: 32 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,38 @@
</p>
<br/>

### Publishing

## Set up the codebase

### Set up pnpm

Install `pnpm` globally:

```bash
npm install -g pnpm
```

### Install dependencies

```bash
pnpm install
```

## Developing

### Build the codebase

```bash
pnpm build
```

### Run the tests

```bash
pnpm test
```

## Publishing
In order to publish you need to make sure that the pull request you're submitting has a changeset. If you don't want to publish this isn't needed.
In order to generate a changeset run `pnpm changeset`, select a change type [major,minor,patch], and draft a small summary of the changeset.

Expand Down

0 comments on commit 36e9091

Please sign in to comment.