@@ -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://bunpkg .com/features/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 ` in the root directory to install the required dependencies for each package:
1515
1616``` sh
17- yarn
17+ bun
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 cannot use [ ` npm ` ] ( https://github.com/npm/cli ) 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,19 +28,19 @@ 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 confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:
@@ -54,26 +54,26 @@ Note the `"fabric":true` and `"concurrentRoot":true` properties.
5454To run the example app on Web:
5555
5656``` sh
57- yarn example web
57+ bun example web
5858```
5959
6060Make sure your code passes TypeScript and ESLint. Run the following to verify:
6161
6262``` sh
63- yarn typecheck
64- yarn lint
63+ bun typecheck
64+ bun lint
6565```
6666
6767To fix formatting errors, run the following:
6868
6969``` sh
70- yarn lint --fix
70+ bun lint --fix
7171```
7272
7373Remember to add tests for your change if possible. Run the unit tests by:
7474
7575``` sh
76- yarn test
76+ bun test
7777```
7878
7979### Commit message convention
@@ -104,20 +104,20 @@ We use [release-it](https://github.com/release-it/release-it) to make it easier
104104To publish new versions, run the following:
105105
106106``` sh
107- yarn release
107+ bun release
108108```
109109
110110### Scripts
111111
112112The ` package.json ` file contains various scripts for common tasks:
113113
114- - ` yarn ` : setup project by installing dependencies.
115- - ` yarn typecheck` : type-check files with TypeScript.
116- - ` yarn lint` : lint files with ESLint.
117- - ` yarn test` : run unit tests with Jest.
118- - ` yarn example start` : start the Metro server for the example app.
119- - ` yarn example android` : run the example app on Android.
120- - ` yarn example ios` : run the example app on iOS.
114+ - ` bun ` : setup project by installing dependencies.
115+ - ` bun typecheck` : type-check files with TypeScript.
116+ - ` bun lint` : lint files with ESLint.
117+ - ` bun test` : run unit tests with Jest.
118+ - ` bun example start` : start the Metro server for the example app.
119+ - ` bun example android` : run the example app on Android.
120+ - ` bun example ios` : run the example app on iOS.
121121
122122### Sending a pull request
123123
0 commit comments