Skip to content

Commit 40c3a53

Browse files
author
alvaromb
committed
Updated README
1 parent 44b1c26 commit 40c3a53

File tree

1 file changed

+27
-5
lines changed

1 file changed

+27
-5
lines changed

README.md

Lines changed: 27 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,36 @@
11
# react-native-js-cascade-picker
22

3+
<p>
4+
<img src="https://img.shields.io/npm/dm/react-native-js-cascade-picker.svg" />
5+
<img src="https://img.shields.io/npm/dt/react-native-js-cascade-picker.svg" />
6+
</p>
7+
8+
A pure JavaScript animated component that renders a picker with a cascade effect. Useful for navigation bars.
9+
310
## Getting started
411

5-
`$ npm install react-native-js-cascade-picker --save`
12+
`$ yarn add react-native-js-cascade-picker`
613

714
## Usage
815

9-
```javascript
10-
import RNReactNativeJsCascadePicker from 'react-native-js-cascade-picker'
16+
```jsx
17+
import CascadePicker from 'react-native-js-cascade-picker'
1118

12-
// TODO: What to do with the module?
13-
RNReactNativeJsCascadePicker
19+
// Render your component
20+
<CascadePicker
21+
options={[{ value: 2, label: 'Two' }, { value: 4, label: 'Four' }]}
22+
valueSelected={2}
23+
onChange={() => null}
24+
pickerText='Hello'
25+
/>
1426
```
27+
28+
## License
29+
30+
MIT.
31+
32+
## Author
33+
34+
Álvaro Medina Ballester `<amedina at apsl.net>`
35+
36+
Built with 💛 by [APSL](https://github.com/apsl).

0 commit comments

Comments
 (0)