Skip to content

Commit a5405e5

Browse files
committed
Copy-editing
1 parent 8b177c1 commit a5405e5

File tree

2 files changed

+17
-10
lines changed

2 files changed

+17
-10
lines changed

markdowns/getting-started/setup.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@ path: "/getting-started/setup"
44
title: "Setup"
55
---
66

7-
## UILib Packages
8-
Before you start.
9-
Starting version 5.12.0 UILib exports individual packages so you can import only what you need.
7+
## Before You Start: UILib Packages
8+
9+
Starting with version 5.12.0 UILib exports individual packages so you can import only what you need.
1010

1111
### Why packages are important?
1212
- Smaller bundle size. By importing only the components you need, your bundle size will be reduced to the files that were imported.
13-
- Quicker setup. Avoid installing peer dependencies and linking native depdencies that you don't need.
13+
- Quicker setup. Avoid installing peer dependencies and linking native dependencies you don't need.
1414

1515
### How does it work?
1616
```javascript
@@ -26,10 +26,10 @@ import {KeyboardTrackingView, KeyboardAwareInsetsView, KeyboardRegistry, Keyboar
2626
First, run `npm install react-native-ui-lib`
2727

2828
### Peer Dependencies
29-
If you're planning on using specific components, see **UILib Packages**.
29+
If you plan on using specific components, see **UILib Packages** above.
3030
*For some packages you might still need to install one of the peer dependencies*
3131

32-
If you want it all, install **peer dependencies**
32+
If you want it all, install **peer dependencies**:
3333
```js
3434
npm i react-native-gesture-handler react-native-reanimated @react-native-community/blur @react-native-community/datetimepicker @react-native-community/netinfo @react-native-picker/picker
3535

@@ -38,11 +38,12 @@ cd ios && pod install
3838

3939

4040
## Install Native Dependencies
41-
If you're planning on using specific components, see **UILib Packages**.
41+
If you plan on using specific components, see **UILib Packages**.
4242
*For some packages you might still need to install one of the native dependencies*
4343

44-
Some of the components are using the following native dependencies, they are defined as peer dependencies so you can install the version that suit you.
45-
It's important to run `cd ios && pod install` if you are using a component that has native dependency
44+
Some of the components are using the native dependencies listed below - those are defined as peer dependencies, so you can install the version that suits you.
45+
46+
> It's important to run `cd ios && pod install` if you are using a component that has a native dependency.
4647
4748
- "react-native-gesture-handler": ">=1.9.0" (mandatory)
4849
- "react-native-reanimated": ">=1.13.2" (mandatory)
@@ -59,4 +60,4 @@ Our demo app is located [here](https://github.com/wix/react-native-ui-lib/tree/m
5960
- Install dependencies: `npm install`
6061
- (for iOS) `cd ios && pod install && cd ..`
6162
- Start the packager: `npm start`
62-
- Build the app: `npm run ios` or `npm run android` (or from Xcode or Android Studio)
63+
- Build the app: `npm run ios` or `npm run android` (or from Xcode or Android Studio).

markdowns/getting-started/usage.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ title: "Usage"
66
This is a quick example of how to use our basic components, modifiers and presets to generate a good looking screen. <br>
77
For detailed information please go over the other sections: Style, Modifiers, Components...
88

9+
<!--
10+
COPY-EDITOR NOTE
11+
12+
The renders of the phone screen image I get in both Chrome and in the VSCode Markdown preview show the phone image overlaying the code part and the text above it - please check the layout of the image in the rendered docs.
13+
-->
14+
915
<img style="float: right; margin-top: -70px" src="https://cloud.githubusercontent.com/assets/1780255/24791489/f5db80f4-1b82-11e7-8538-5a3388fb4345.png" width=300 />
1016

1117
```jsx

0 commit comments

Comments
 (0)