Skip to content

Commit ae90179

Browse files
authored
Merge pull request #12 from Naturalclar/chore/addREADMEBadges
Chore/add readme badges
2 parents c868b13 + a8bece8 commit ae90179

File tree

1 file changed

+46
-6
lines changed

1 file changed

+46
-6
lines changed

README.md

Lines changed: 46 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,54 @@
11
# @react-native-community/react-native-progress-view
22

3+
[![Build Status][build-badge]][build]
4+
[![Version][version-badge]][package]
5+
![Supports iOS][support-badge]
6+
[![MIT License][license-badge]][license]
7+
[![Lean Core Badge][lean-core-badge]][lean-core-issue]
8+
39
Use `ProgressViewIOS` to render a UIProgressView on iOS.
4-
It was part of React Native Core.
510

611
## Getting started
712

8-
`$ npm install @react-native-community/react-native-progress-view --save`
13+
```
14+
$ npm install @react-native-community/react-native-progress-view --save
15+
```
16+
17+
or
18+
19+
```
20+
$ yarn add @react-native-community/react-native-progress-view
21+
```
22+
23+
### Linking
24+
25+
- React Native 0.60+
926

10-
### Mostly automatic installation
27+
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:
1128

12-
`$ react-native link @react-native-community/react-native-progress-view`
29+
```
30+
$ cd ios && pod install
31+
```
32+
33+
- React Native <= 0.59
34+
35+
Run the following commands
36+
37+
```
38+
$ react-native link @react-native-community/react-native-progress-view
39+
```
1340

1441
### Manual installation
1542

16-
#### iOS
43+
<details>
44+
<summary>Manually linking the library - iOS</summary>
1745

1846
1. In XCode, in the project navigator, right click `Libraries``Add Files to [your project's name]`
1947
2. Go to `node_modules``@react-native-community/react-native-progress-view` and add `RNCProgressView.xcodeproj`
2048
3. In XCode, in the project navigator, select your project. Add `libRNCProgressView.a` to your project's `Build Phases``Link Binary With Libraries`
21-
4. Run your project (`Cmd+R`)<
49+
4. Run your project (`Cmd+R`)
50+
51+
</details>
2252

2353
## Usage
2454

@@ -110,3 +140,13 @@ The tint color of the progress bar track.
110140
## License
111141

112142
The library is released under the MIT license. For more information see [`LICENSE`](/LICENSE).
143+
144+
[build-badge]: https://img.shields.io/circleci/project/github/react-native-community/react-native-progress-view/master.svg?style=flat-square
145+
[build]: https://circleci.com/gh/react-native-community/react-native-progress-view
146+
[version-badge]: https://img.shields.io/npm/v/@react-native-community/react-native-progress-view.svg?style=flat-square
147+
[package]: https://www.npmjs.com/package/@react-native-community/react-native-progress-view
148+
[support-badge]:https://img.shields.io/badge/platforms-ios-lightgrey.svg?style=flat-square
149+
[license-badge]: https://img.shields.io/npm/l/@react-native-community/react-native-progress-view.svg?style=flat-square
150+
[license]: https://opensource.org/licenses/MIT
151+
[lean-core-badge]: https://img.shields.io/badge/Lean%20Core-Extracted-brightgreen.svg?style=flat-square
152+
[lean-core-issue]: https://github.com/facebook/react-native/issues/23313

0 commit comments

Comments
 (0)