|
1 | 1 | # React Native Dropdown Picker |
2 | 2 |
|
3 | | -[](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/LICENSE) |
| 3 | +[](https://github.com/hossein-zare/react-native-dropdown-picker) |
| 4 | +[](https://actions-badge.atrox.dev/hossein-zare/react-native-dropdown-picker/goto?ref=dev-5.x) |
| 5 | +[](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/LICENSE) |
4 | 6 | [](https://www.npmjs.org/package/react-native-dropdown-picker) |
5 | | - |
6 | | -[//]: # (TODO: add badge linking to GitHub repo) |
| 7 | +[](https://www.npmjs.org/package/react-native-dropdown-picker) |
| 8 | +[](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs) |
7 | 9 |
|
8 | 10 | --- |
9 | 11 |
|
10 | | -## Screenshots |
| 12 | +## 📱 Screenshots |
11 | 13 |
|
12 | | -<p float="left"> |
13 | | - <img src="https://user-images.githubusercontent.com/56504893/116790110-e0b36880-aac7-11eb-9ebd-196acee64f7a.png" |
14 | | - width="270" alt="Screenshot showing basic dropdown" /> |
15 | | - <img src="https://user-images.githubusercontent.com/56504893/116789802-faec4700-aac5-11eb-837b-86f18cbfcf3d.png" |
16 | | - width="270" alt="Screenshot showing badges" /> |
17 | | - <img src="https://user-images.githubusercontent.com/56504893/116789839-2c651280-aac6-11eb-99e0-b43b608ed8c7.png" |
18 | | - width="270" alt="Screenshot showing dark theme and parent items" /> |
19 | | -</p> |
| 14 | +[](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/basic_full.png) |
| 15 | +[](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/badges_full.png) |
| 16 | +[](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/dark_theme_parent_items_full.png) |
20 | 17 |
|
21 | 18 | The above screenshots were taken |
22 | 19 | from [this example](https://snack.expo.dev/8mHmLfcZf). |
23 | 20 |
|
24 | | -## Usage |
| 21 | +## 👋 Usage |
25 | 22 |
|
26 | 23 | ### Basic usage |
27 | 24 |
|
28 | | -The following code shows basic usage of the library: |
| 25 | +The following code shows basic usage of this library: |
29 | 26 |
|
30 | 27 | ```javascript |
31 | 28 | import React, {useState} from 'react'; |
@@ -77,15 +74,15 @@ export default function App() { |
77 | 74 |
|
78 | 75 | You can find more examples in the `examples` subdirectory. This subdirectory is |
79 | 76 | a working [Expo](https://github.com/expo/expo) project demonstrating this |
80 | | -library. It shows how to use the library with class components as well as with |
| 77 | +library. It shows how to use this library with class components as well as with |
81 | 78 | function components, and in TypeScript as well as in JavaScript. Navigate into |
82 | 79 | the `examples` subdirectory, run `npm install`, and then run `npx expo start` to |
83 | 80 | see the examples working. |
84 | 81 |
|
85 | 82 | For further information on how to use this library, |
86 | | -read [the relevant documentation](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs/usage). |
| 83 | +read [the usage documentation](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs/usage). |
87 | 84 |
|
88 | | -## Further documentation |
| 85 | +## 📄 Further documentation |
89 | 86 |
|
90 | 87 | The docs can be read |
91 | 88 | at: [https://hossein-zare.github.io/react-native-dropdown-picker-website](https://hossein-zare.github.io/react-native-dropdown-picker-website) |
@@ -115,10 +112,10 @@ To make a new release, follow these steps: |
115 | 112 |
|
116 | 113 | * Verify the development branch has all the changes desired in the release and |
117 | 114 | works well |
118 | | -* You can test changes to the library and experiment easily |
| 115 | +* You can test changes to this library and experiment easily |
119 | 116 | with [patch-package](https://www.npmjs.com/package/patch-package) |
120 | 117 | * Once you have made changes, and after finalizing them, use `npm pack` |
121 | | - to [test your new, changed version of the library locally and check it works correctly](https://dev.to/scooperdev/use-npm-pack-to-test-your-packages-locally-486e) |
| 118 | + to [test your new, changed version of this library locally and check it works correctly](https://dev.to/scooperdev/use-npm-pack-to-test-your-packages-locally-486e) |
122 | 119 | * Make and merge a final PR into the development branch that increments the |
123 | 120 | version number in `package.json` |
124 | 121 | * Make and merge a PR from the development branch to the release branch |
|
0 commit comments