Skip to content

Commit 20ef969

Browse files
committed
docs: update setup action and docs to use bun
Fixed working-directory in setup action. Updated CONTRIBUTING.md and README.md to reference Bun instead of Yarn.
1 parent f6f9809 commit 20ef969

File tree

3 files changed

+20
-22
lines changed

3 files changed

+20
-22
lines changed

.github/actions/setup/action.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,5 @@ runs:
1111

1212
- name: Install dependencies
1313
shell: bash
14-
working-directory: react-native-libprisma
14+
1515
run: bun install --frozen-lockfile

CONTRIBUTING.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,20 @@ 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

1414
To get started with the project, make sure you have the correct version of [Node.js](https://nodejs.org/) installed. See the [`.nvmrc`](./.nvmrc) file for the version used in this project.
1515

16-
Run `yarn` in the root directory to install the required dependencies for each package:
16+
Run `bun install` in the root directory to install the required dependencies for each package:
1717

1818
```sh
19-
yarn
19+
bun install
2020
```
2121

22-
> Since the project relies on Yarn workspaces, you cannot use [`npm`](https://github.com/npm/cli) for development without manually migrating.
22+
> Since the project relies on Bun workspaces, you cannot use [`npm`](https://github.com/npm/cli) or [`yarn`](https://yarnpkg.com/) for development.
2323
2424
The [example app](/example/) demonstrates usage of the library. You need to run it to test any changes you make.
2525

@@ -34,19 +34,19 @@ You can use various commands from the root directory to work with the project.
3434
To start the packager:
3535

3636
```sh
37-
yarn example start
37+
bun example start
3838
```
3939

4040
To run the example app on Android:
4141

4242
```sh
43-
yarn example android
43+
bun example android
4444
```
4545

4646
To run the example app on iOS:
4747

4848
```sh
49-
yarn example ios
49+
bun example ios
5050
```
5151

5252
To confirm that the app is running with the new architecture, you can check the Metro logs for a message like this:
@@ -60,25 +60,25 @@ Note the `"fabric":true` and `"concurrentRoot":true` properties.
6060
Make sure your code passes TypeScript:
6161

6262
```sh
63-
yarn typecheck
63+
bun typecheck
6464
```
6565

6666
To check for linting errors, run the following:
6767

6868
```sh
69-
yarn lint
69+
bun lint
7070
```
7171

7272
To fix formatting errors, run the following:
7373

7474
```sh
75-
yarn lint --fix
75+
bun lint --fix
7676
```
7777

7878
Remember to add tests for your change if possible. Run the unit tests by:
7979

8080
```sh
81-
yarn test
81+
bun test
8282
```
8383

8484

@@ -103,21 +103,21 @@ We use [release-it](https://github.com/release-it/release-it) to make it easier
103103
To publish new versions, run the following:
104104

105105
```sh
106-
yarn release
106+
bun run release
107107
```
108108

109109

110110
### Scripts
111111

112112
The `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](https://eslint.org/).
117-
- `yarn test`: run unit tests with [Jest](https://jestjs.io/).
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 install`: setup project by installing dependencies.
115+
- `bun typecheck`: type-check files with TypeScript.
116+
- `bun lint`: lint files with [ESLint](https://eslint.org/).
117+
- `bun test`: run unit tests with [Jest](https://jestjs.io/).
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

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,6 @@
4545
```bash
4646
npm install react-native-libprisma
4747
# or
48-
yarn add react-native-libprisma
49-
# or
5048
bun add react-native-libprisma
5149
```
5250

0 commit comments

Comments
 (0)