@@ -6,18 +6,18 @@ We want this community to be friendly and respectful to each other. Please follo
66
77## Development workflow
88
9- This project is a monorepo managed using [ Yarn workspaces] ( https://yarnpkg.com/features /workspaces ) . It contains the following packages:
9+ This project is a monorepo managed using [ Bun workspaces] ( https://bun.sh/docs/install /workspaces ) . It contains the following packages:
1010
1111- The library package in the root directory.
1212- An example app in the ` example/ ` directory.
1313
14- To get started with the project, run ` yarn ` in the root directory to install the required dependencies for each package:
14+ To get started with the project, run ` bun install ` in the root directory to install the required dependencies for each package:
1515
1616``` sh
17- yarn
17+ bun install
1818```
1919
20- > Since the project relies on Yarn workspaces, you cannot use [ ` npm ` ] ( https://github.com/npm/cli ) for development.
20+ > Since the project relies on Bun workspaces, you should use [ ` bun ` ] ( https://bun.sh ) for development.
2121
2222The [ example app] ( /example/ ) demonstrates usage of the library. You need to run it to test any changes you make.
2323
@@ -28,44 +28,44 @@ You can use various commands from the root directory to work with the project.
2828To start the packager:
2929
3030``` sh
31- yarn example start
31+ bun example start
3232```
3333
3434To run the example app on Android:
3535
3636``` sh
37- yarn example android
37+ bun example android
3838```
3939
4040To run the example app on iOS:
4141
4242``` sh
43- yarn example ios
43+ bun example ios
4444```
4545
4646To run the example app on Web:
4747
4848``` sh
49- yarn example web
49+ bun example web
5050```
5151
5252Make sure your code passes TypeScript and ESLint. Run the following to verify:
5353
5454``` sh
55- yarn typecheck
56- yarn lint
55+ bun run typecheck
56+ bun run lint
5757```
5858
5959To fix formatting errors, run the following:
6060
6161``` sh
62- yarn lint --fix
62+ bun run lint --fix
6363```
6464
6565Remember to add tests for your change if possible. Run the unit tests by:
6666
6767``` sh
68- yarn test
68+ bun test
6969```
7070
7171### Commit message convention
@@ -96,20 +96,20 @@ We use [release-it](https://github.com/release-it/release-it) to make it easier
9696To publish new versions, run the following:
9797
9898``` sh
99- yarn release
99+ bun run release
100100```
101101
102102### Scripts
103103
104104The ` package.json ` file contains various scripts for common tasks:
105105
106- - ` yarn ` : setup project by installing dependencies.
107- - ` yarn typecheck` : type-check files with TypeScript.
108- - ` yarn lint` : lint files with ESLint.
109- - ` yarn test` : run unit tests with Jest.
110- - ` yarn example start` : start the Metro server for the example app.
111- - ` yarn example android` : run the example app on Android.
112- - ` yarn example ios` : run the example app on iOS.
106+ - ` bun install ` : setup project by installing dependencies.
107+ - ` bun run typecheck` : type-check files with TypeScript.
108+ - ` bun run lint` : lint files with ESLint.
109+ - ` bun test` : run unit tests with Jest.
110+ - ` bun example start` : start the Metro server for the example app.
111+ - ` bun example android` : run the example app on Android.
112+ - ` bun example ios` : run the example app on iOS.
113113
114114### Sending a pull request
115115
0 commit comments