Skip to content

Commit 0b8d10e

Browse files
author
Rishabh
committed
updating readme instruction
1 parent 2db612b commit 0b8d10e

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# react-native-rating-element
2+
23
A simple rating library for react native supporting decimal point and custom icon set
4+
5+
## Installation
6+
7+
Use the package manager npm to install react-native-rating-element.
8+
9+
```bash
10+
npm install react-native-rating-element
11+
```
12+
13+
## Usage
14+
15+
```javascript
16+
import Rating from "react-native-rating-element";
17+
18+
<Rating
19+
rated={3.7}
20+
totalCount={5}
21+
ratingColor="#b5121b"
22+
ratingBackgroundColor="#c8c7c8"
23+
size={12}
24+
icon="ios-star"
25+
/>
26+
```
27+
28+
## Contributing
29+
30+
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
31+
32+
Please make sure to update tests as appropriate.
33+
34+
## License
35+
36+
[MIT](https://choosealicense.com/licenses/mit/)

0 commit comments

Comments
 (0)