Skip to content

Commit

Permalink
docs: update README/CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
metonym committed Apr 18, 2024
1 parent b2a1082 commit 223c24e
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Prerequisites

For MacOS, prerequisites include [Node.js](https://nodejs.org/en/download/package-manager/#macos)(version 12 or greater) and [Yarn](https://yarnpkg.com/en/docs/install#mac-stable).
[Bun](https://bun.sh/docs/installation).

## Set-up

Expand All @@ -24,22 +24,22 @@ git remote -v
Finally, install the project dependencies:

```sh
yarn install
bun install
```

## Workflow

### Unit tests

Ensure the unit tests pass by running `yarn test`.
Ensure the unit tests pass by running `bun test`.

### End-to-end (e2e) tests

Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by e2e tests in the `tests/e2e` folder.

Run `yarn build` to build the library. The transpiled JavaScript code is emitted to the `lib` folder.
Run `bun run build` to build the library. The transpiled JavaScript code is emitted to the `lib` folder.

To build the library in watch mode, run `yarn build -w`.
To build the library in watch mode, run `bun run build -w`.

### Continuous Integration

Expand All @@ -66,4 +66,4 @@ git merge upstream/main

### Submit a PR

After you've pushed your changes to remote, submit your PR. Make sure you are comparing `<YOUR_USER_ID>/feature` to `origin/master`.
After you've pushed your changes to remote, submit your PR. Make sure you are comparing `<YOUR_USER_ID>/feature` to `origin/main`.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,11 +147,17 @@ This library adopts a progressively enhanced approach. Any property type that ca
Install `sveld` as a development dependency.

```sh
yarn add -D sveld
# OR
# npm
npm i -D sveld
# OR

# pnpm
pnpm i -D sveld

# Bun
bun i -D sveld

# Yarn
yarn add -D sveld
```

### Rollup
Expand Down

0 comments on commit 223c24e

Please sign in to comment.