Skip to content

Commit f35f127

Browse files
authored
update readme
1 parent 0fa4f33 commit f35f127

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
44
[![NPM version](https://img.shields.io/npm/v/react-native-size-matters.svg)](https://www.npmjs.com/package/react-native-size-matters)
55

6-
A React-Native utility belt for scaling the size your apps UI across different sized devices.
6+
A React-Native utility belt for scaling the size of your apps UI across different sized devices.
77

88
<a href="./examples/ipad.gif">
99
<img src="./examples/ipad.gif" width="320"/>
@@ -17,10 +17,10 @@ yarn add react-native-size-matters
1717
```
1818

1919
## Motivation
20-
When developing with react-native, you need to manually adjust your app to look great on variety of different screen sizes. That's a tedious job.
20+
When developing with react-native, you need to manually adjust your app to look great on a variety of different screen sizes. That's a tedious job.
2121
react-native-size-matters provides some simple tooling to make your scaling a whole lot easier.
2222
The idea is to develop once on a standard ~5" screen mobile device and then simply apply the provided utils.
23-
📖 You can read more about what led to this library on my blog post, that can be found in [this repo](./examples/BlogPost) or at [Soluto Engineering Blog](https://blog.solutotlv.com/size-matters/).
23+
📖 You can read more about what led to this library on my blog post, which can be found in [this repo](./examples/BlogPost) or at [Soluto Engineering Blog](https://blog.solutotlv.com/size-matters/).
2424

2525
## Api
2626
### Scaling Functions
@@ -37,12 +37,12 @@ const Component = props =>
3737

3838

3939
* `scale(size: number)`
40-
Will return linear scaled result of the provided size, based on your device's screen width.
40+
Will return a linear scaled result of the provided size, based on your device's screen width.
4141
* `verticalScale(size: number)`
42-
Will return linear scaled result of the provided size, based on your device's screen height.
42+
Will return a linear scaled result of the provided size, based on your device's screen height.
4343

4444
* `moderateScale(size: number, factor?: number)`
45-
Sometimes you don't want to scale everything in a linear manner, that's where moderate scale comes in.
45+
Sometimes you don't want to scale everything in a linear manner, that's where moderateScale comes in.
4646
The cool thing about it is that you can control the resize factor (default is 0.5).
4747
If normal scale will increase your size by +2X, moderateScale will only increase it by +X, for example:
4848
➡️ scale(10) = 20
@@ -81,10 +81,10 @@ const styles = ScaledSheet.create({
8181

8282
## Changing the Default Guideline Sizes
8383

84-
In the ever changing mobile devices world screen sizes change a lot.
84+
In the ever-changing mobile devices world, screen sizes change a lot.
8585
This lib uses 350dp x 680dp as guideline sizes, but if you (or your designer) prefer using different sizes it's possible.
8686

87-
To do so, first you'd need to setup [react-native-dotenv](https://github.com/zetachang/react-native-dotenv).
87+
To do so, first, you'd need to setup [react-native-dotenv](https://github.com/zetachang/react-native-dotenv).
8888
After setting it up and creating `.env` file, add the following env params to it:
8989
```env
9090
SIZE_MATTERS_BASE_WIDTH=<custom-width>
@@ -97,6 +97,6 @@ import { ScaledSheet, moderateScale } from 'react-native-size-matters/extend';
9797

9898
## Examples
9999
You can clone the [expo-example-app](./examples/expo-example-app) from this repo, run `npm install` and `npm start` and scan the presented QR code in the [Expo app](https://expo.io) on your preferred device.
100-
The app has a on/off switch for using `react-native-size-matters`, so you can test yourself how the app will look with and without scaling.
100+
The app has an on/off switch for using `react-native-size-matters`, so you can test yourself how the app will look with and without scaling.
101101
It is expected to look good on every device you want - iOS or Android, phone or tablet, basically anything (please let me know if not).
102102
There are also some attached screenshots in the repo if you don't feel like cloning.

0 commit comments

Comments
 (0)