Skip to content

Commit e5f7d49

Browse files
committed
docs: clarify README regarding setup
1 parent 06cf91d commit e5f7d49

File tree

1 file changed

+10
-12
lines changed

1 file changed

+10
-12
lines changed

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,14 +41,6 @@ Just as an example, this is a command we have in one of the packages: `babel --e
4141

4242
Bob wraps tools such as `babel` and `typescript` to simplify these common tasks across multiple projects. It's tailored specifically to React Native projects to minimize the configuration required.
4343

44-
## Installation
45-
46-
Open a Terminal in your project, and run:
47-
48-
```sh
49-
yarn add --dev @react-native-community/bob
50-
```
51-
5244
## Usage
5345

5446
### Creating a new project
@@ -65,6 +57,12 @@ The difference from [create-react-native-module](https://github.com/brodybits/cr
6557

6658
### Configuring an existing project
6759

60+
First, install Bob in your project. Open a Terminal in your project, and run:
61+
62+
```sh
63+
yarn add --dev @react-native-community/bob
64+
```
65+
6866
To configure your project to use Bob, open a Terminal and run `yarn bob init` for automatic configuration.
6967

7068
To configure your project manually, follow these steps:
@@ -86,15 +84,15 @@ To configure your project manually, follow these steps:
8684

8785
See options below for more details.
8886

89-
1. Add `bob` to your `prepare` step:
87+
2. Add `bob` to your `prepare` step:
9088

9189
```js
9290
"scripts": {
9391
"prepare": "bob build"
9492
}
9593
```
9694

97-
1. Configure the appropriate entry points:
95+
3. Configure the appropriate entry points:
9896

9997
```json
10098
"main": "lib/commonjs/index.js",
@@ -113,14 +111,14 @@ To configure your project manually, follow these steps:
113111

114112
If you're building TypeScript definition files, also make sure that the `types` field points to a correct path. Depending on the project configuration, the path can be different for you than the example snippet.
115113

116-
1. Add the output directory to `.gitignore` and `.eslintignore`
114+
4. Add the output directory to `.gitignore` and `.eslintignore`
117115

118116
```gitignore
119117
# generated files by bob
120118
lib/
121119
```
122120

123-
1. Add the output directory to `jest.modulePathIgnorePatterns` if you use [Jest](https://jestjs.io)
121+
5. Add the output directory to `jest.modulePathIgnorePatterns` if you use [Jest](https://jestjs.io)
124122

125123
```json
126124
"modulePathIgnorePatterns": ["<rootDir>/lib/"]

0 commit comments

Comments
 (0)