Skip to content

Commit 747fda0

Browse files
authored
chore: refactored screenshots and added badges to README.md (#714)
1 parent 69a56ba commit 747fda0

File tree

7 files changed

+16
-19
lines changed

7 files changed

+16
-19
lines changed
9.7 KB
Loading
Loading
7.13 KB
Loading
Loading
Loading
Loading

README.md

Lines changed: 16 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,28 @@
11
# React Native Dropdown Picker
22

3-
[![react-native-dropdown-picker is released under the MIT license.](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/LICENSE)
3+
[![GitHub repo](https://img.shields.io/badge/GitHub_repo-grey?logo=github)](https://github.com/hossein-zare/react-native-dropdown-picker)
4+
[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fhossein-zare%2Freact-native-dropdown-picker%2Fbadge%3Fref%3Ddev-5.x&style=flat)](https://actions-badge.atrox.dev/hossein-zare/react-native-dropdown-picker/goto?ref=dev-5.x)
5+
[![react-native-dropdown-picker is released under the MIT license.](https://img.shields.io/github/license/hossein-zare/react-native-dropdown-picker)](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/LICENSE)
46
[![Current npm package version.](https://img.shields.io/npm/v/react-native-dropdown-picker?color=brightgreen&label=npm%20package)](https://www.npmjs.org/package/react-native-dropdown-picker)
5-
6-
[//]: # (TODO: add badge linking to GitHub repo)
7+
[![Weekly npm downloads](https://img.shields.io/npm/dw/react-native-dropdown-picker)](https://www.npmjs.org/package/react-native-dropdown-picker)
8+
[![Documentation](https://img.shields.io/badge/Documentation-grey)](https://hossein-zare.github.io/react-native-dropdown-picker-website/docs)
79

810
---
911

10-
## Screenshots
12+
## 📱 Screenshots
1113

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+
[![Screenshot showing basic dropdown](.github/assets/images/screenshots/basic.png)](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/basic_full.png)
15+
[![Screenshot showing badges](.github/assets/images/screenshots/badges.png)](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/badges_full.png)
16+
[![Screenshot showing dark theme and parent items](.github/assets/images/screenshots/dark_theme_parent_items.png)](https://github.com/hossein-zare/react-native-dropdown-picker/blob/dev-5.x/.github/assets/images/screenshots/dark_theme_parent_items_full.png)
2017

2118
The above screenshots were taken
2219
from [this example](https://snack.expo.dev/8mHmLfcZf).
2320

24-
## Usage
21+
## 👋 Usage
2522

2623
### Basic usage
2724

28-
The following code shows basic usage of the library:
25+
The following code shows basic usage of this library:
2926

3027
```javascript
3128
import React, {useState} from 'react';
@@ -77,15 +74,15 @@ export default function App() {
7774

7875
You can find more examples in the `examples` subdirectory. This subdirectory is
7976
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
8178
function components, and in TypeScript as well as in JavaScript. Navigate into
8279
the `examples` subdirectory, run `npm install`, and then run `npx expo start` to
8380
see the examples working.
8481

8582
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).
8784

88-
## Further documentation
85+
## 📄 Further documentation
8986

9087
The docs can be read
9188
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:
115112

116113
* Verify the development branch has all the changes desired in the release and
117114
works well
118-
* You can test changes to the library and experiment easily
115+
* You can test changes to this library and experiment easily
119116
with [patch-package](https://www.npmjs.com/package/patch-package)
120117
* 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)
122119
* Make and merge a final PR into the development branch that increments the
123120
version number in `package.json`
124121
* Make and merge a PR from the development branch to the release branch

0 commit comments

Comments
 (0)