Skip to content

Commit 23b5c89

Browse files
authored
Merge pull request #23 from react-native-community/Naturalclar-patch-1
Cleaning up README.md
2 parents 5d28847 + 210266d commit 23b5c89

File tree

1 file changed

+37
-27
lines changed

1 file changed

+37
-27
lines changed

README.md

Lines changed: 37 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -7,46 +7,39 @@
77
[![MIT License][license-badge]][license]
88
[![Lean Core Badge][lean-core-badge]][lean-core-issue]
99

10-
## Getting started
11-
12-
`$ npm install @react-native-community/progress-bar-android --save`
10+
Progress Bar Component for Android Devices
1311

14-
or
12+
![Screenshot](https://user-images.githubusercontent.com/25158423/57262658-0d4c5b00-703b-11e9-9e0d-bdf7cb8f942a.gif)
1513

16-
`$ yarn add @react-native-community/progress-bar-android`
14+
## Getting started
1715

18-
## Example setup
19-
![](https://user-images.githubusercontent.com/25158423/57262658-0d4c5b00-703b-11e9-9e0d-bdf7cb8f942a.gif)
16+
```
17+
$ npm install @react-native-community/progress-bar-android --save
18+
```
2019

21-
### Android
22-
1. Install dependencies
23-
1. Install dependencies for example folder
24-
1. Start the metro bundler
25-
1. Build the application
20+
or
2621

27-
```sh
28-
yarn install
29-
cd example
30-
# inside example
31-
yarn install
32-
yarn start
33-
yarn android
22+
```
23+
$ yarn add @react-native-community/progress-bar-android
3424
```
3525

36-
### Mostly automatic installation
26+
### Linking
3727

38-
- `react-native >= 0.60`
28+
- React Native 0.60+
3929

4030
The package is [automatically linked](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) when building the app. All you need to do is:
4131

42-
``` ```
43-
cd ios && pod install
44-
``` ```
32+
```
33+
$ cd ios && pod install
34+
```
4535

46-
- `react-native < 0.59`
36+
- React Native <= 0.59
4737

4838
Run the following commands
49-
`$ react-native link @react-native-community/progress-bar-android`
39+
40+
```
41+
$ react-native link @react-native-community/progress-bar-android
42+
```
5043

5144
### Manual installation
5245

@@ -78,6 +71,23 @@ Run the following commands
7871

7972
</details>
8073

74+
## Trying out this package in `example`
75+
76+
### Android
77+
1. Install dependencies
78+
1. Install dependencies for example folder
79+
1. Start the metro bundler
80+
1. Build the application
81+
82+
```sh
83+
yarn install
84+
cd example
85+
# inside example
86+
yarn install
87+
yarn start
88+
yarn android
89+
```
90+
8191
## Usage
8292
```jsx
8393
import { View } from 'react-native'
@@ -102,4 +112,4 @@ export const Example = () => {
102112
[license-badge]: https://img.shields.io/npm/l/@react-native-community/progress-bar-android.svg?style=flat-square
103113
[license]: https://opensource.org/licenses/MIT
104114
[lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square
105-
[lean-core-issue]: https://github.com/facebook/react-native/issues/23313
115+
[lean-core-issue]: https://github.com/facebook/react-native/issues/23313

0 commit comments

Comments
 (0)