Skip to content

Commit f8f5e64

Browse files
dale-frenchjhen0409
authored andcommitted
Updated readme to read in better English (#275)
1 parent 23b6e96 commit f8f5e64

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

docs/getting-started.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Getting Started
22

3-
Just these steps let you start RNDebugger out of box:
3+
Just these steps will let you start RNDebugger out of box:
44

55
- Make sure all debugger clients of React Native are closed, usually are `http://localhost:<port>/debugger-ui`
66
- Make sure RNDebugger is open and wait state.
@@ -11,13 +11,13 @@ Just these steps let you start RNDebugger out of box:
1111

1212
### The `rndebugger:` URI scheme
1313

14-
Launch RNDebugger by the following command:
14+
Launch RNDebugger by typing the following command:
1515

1616
```bash
1717
$ open "rndebugger://set-debugger-loc?host=localhost&port=8081"
1818
```
1919

20-
The `host`, `port` is mean React Native packager, you may need to set `port` if you custom the packager port. (`8081` by default)
20+
The `host` / `port` means React Native packager. You may need to set `port` if you customize the packager port. (`8081` by default)
2121

2222
From [`Debugging using a custom JavaScript debugger`](https://facebook.github.io/react-native/docs/debugging.html#debugging-using-a-custom-javascript-debugger) of React Native docs, you can use `REACT_DEBUGGER` env on react-native packager, it will try to launch RNDebugger when you turn on `Debug JS Remotely`. For example, [Artsy's Emission](https://github.com/artsy/emission/blob/45417ca425f2cba7d2da21902ef8ff1cd093a024/package.json#L28) using the env for launch RNDebugger:
2323

@@ -31,11 +31,11 @@ Special case of Expo (CRNA):
3131
$ REACT_DEBUGGER="unset ELECTRON_RUN_AS_NODE && open -g 'rndebugger://set-debugger-loc?port=19001' ||" npm start
3232
```
3333

34-
**_NOTE_** Currently the `REACT_DEBUGGER` env doesn't work with Haul bundler, please tracking [issue #141](https://github.com/jhen0409/react-native-debugger/issues/141).
34+
**_NOTE_** Currently the `REACT_DEBUGGER` env doesn't work with Haul bundler, please track [issue #141](https://github.com/jhen0409/react-native-debugger/issues/141) for more information.
3535

3636
### Use [`react-native-debugger-open`](../npm-package)
3737

38-
If you don‘t care to add a dependency, you can use the package, it can help to:
38+
If you don‘t need to add a dependency, you can use the package, it can help with:
3939

4040
- Replace `open debugger-ui with Chrome` to `open React Native Debugger` in react-native packager, saving you from closing the debugger-ui page everytime it automatically opens :)
4141
- Detect react-native packager port then send to the app, if you launch packager with custom `--port` or use Expo, this will be very useful
@@ -44,19 +44,19 @@ If you don‘t care to add a dependency, you can use the package, it can help to
4444

4545
Currently the `rndebugger:` URI scheme doesn't support for Linux / Windows.
4646

47-
In [`react-native-debugger-open`](../npm-package), it can be send `host`, `port` setting if RNDebugger opened, but can't automatically open if closed.
47+
In [`react-native-debugger-open`](../npm-package), it can be sent the `host` / `port` setting if RNDebugger opened, but can't automatically open if closed.
4848

49-
If you want to have the feature (`rndebugger:` or another way), welcome to [contributing](https://github.com/jhen0409/react-native-debugger/blob/master/docs/contributing.md) and become the maintainer.
49+
If you want to have the feature (`rndebugger:` or another way), you are welcome to contribute. Please read [contributing](https://github.com/jhen0409/react-native-debugger/blob/master/docs/contributing.md) to become a maintainer.
5050

5151
## Use Redux DevTools Extension API
5252

53-
Use the same API as [`redux-devtools-extension`](https://github.com/zalmoxisus/redux-devtools-extension#1-with-redux) is very simple:
53+
Using the same API as [`redux-devtools-extension`](https://github.com/zalmoxisus/redux-devtools-extension#1-with-redux) is very simple:
5454

5555
```js
5656
const store = createStore(
5757
reducer /* preloadedState, */,
58-
window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__(),
59-
)
58+
window.__REDUX_DEVTOOLS_EXTENSION__ && window.__REDUX_DEVTOOLS_EXTENSION__()
59+
);
6060
```
6161

6262
See [`Redux DevTools Integration`](redux-devtools-integration.md) section for more information.
@@ -72,13 +72,13 @@ See [`Redux DevTools Integration`](redux-devtools-integration.md) section for mo
7272
- [`Redux counter`](../examples/counter-with-redux)
7373
- [`MobX counter`](../examples/counter-with-mobx) - with [`mobx-remotedev`](https://github.com/zalmoxisus/mobx-remotedev).
7474

75-
The examples was bootstrapped with [`create-react-native-app`](https://github.com/react-community/create-react-native-app).
75+
The examples were bootstrapped with [`create-react-native-app`](https://github.com/react-community/create-react-native-app).
7676

7777
## Auto-update RNDebugger app (Supported v0.5.0 after)
7878

79-
Currently auto-update is only supported for macOS, for Linux / Windows will show dialog of new version available for download.
79+
Currently auto-update is only supported for macOS. Linux and Windows will show a dialog of new versions available for download.
8080

81-
You can also click `React Native Debugger` (`RND` for Linux / Windows) -> `Check for Updates...` in application menu.
81+
You can also click `React Native Debugger` (`RND` for Linux / Windows) -> `Check for Updates...` in the application menu.
8282

8383
## Other documentations
8484

0 commit comments

Comments
 (0)