docs: update README/CONTRIBUTING

carbon-design-system · Apr 9, 2024 · 0765426 · 0765426
1 parent b46fec5
commit 0765426
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 23 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -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
 
@@ -24,33 +24,24 @@ 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:unit`.
+Ensure the unit tests pass by running `bun test`.
 
-### Integration tests
+### End-to-end (e2e) tests
 
-Because this library is written in TypeScript, it must be transpiled to JavaScript before it can be used by integration tests in the `integration` folder.
+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:watch`.
+To build the library in watch mode, run `bun run build -w`.
 
-### Continuous Integration
-
-The `yarn prepack` command is executed in Travis CI.
-
-It does the following:
-
-1. Build the library
-2. Run unit/svelte-check/integration tests in parallel
-
-The CI should pass if no unexpected errors occur.
+Then, run `bun test:e2e` to run the e2e tests.
 
 ## Submitting a Pull Request
 
@@ -60,10 +51,10 @@ Before submitting a pull request, make sure your fork is up to date with the lat
 
 ```sh
 git fetch upstream
-git checkout master
-git merge upstream/master
+git checkout main
+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`.
diff --git a/README.md b/README.md
@@ -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