Skip to content

Commit

Permalink
Readme enhancement (#25)
Browse files Browse the repository at this point in the history
* Add some badges

* Add example section

* Add PR template
  • Loading branch information
VincentCATILLON authored Apr 30, 2020
1 parent 63e963f commit 0b6421d
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Description

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec eu aliquam velit. Aliquam luctus, odio dignissim lacinia molestie, sem odio accumsan libero, sed pretium enim sem id nisi.

### Result

Phasellus ornare sapien at bibendum pellentesque. Curabitur odio diam, finibus sed pretium et, tincidunt quis neque. Donec aliquet quam vulputate purus consectetur pulvinar. Nullam rhoncus arcu eget tempus euismod. Donec commodo tempor diam, sodales commodo velit maximus ac.

<table>
<thead>
<tr>
<th>Before</th>
<th>After</th>
</tr>
</thead>
<tbody>
<tr>
<td>
__WIP__
</td>
<td>
__WIP__
</td>
</tr>
</tbody>
</table>

### Related issues

- [ ] [Is there any issue ?](https://github.com/VincentCATILLON/react-native-confetti-cannon/issues/1337)
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,10 @@
<img height="400" src="https://github.com/VincentCATILLON/react-native-confetti-cannon/raw/master/.github/demo.gif" alt="React-native-confetti-cannon">
</p>

![https://img.shields.io/badge/Platforms-iOS%20%7C%C2%A0Android%20%7C%20Web-blue](https://img.shields.io/badge/Platforms-iOS%20%7C%C2%A0Android%20%7C%20Web-blue)
[![CircleCI](https://circleci.com/gh/VincentCATILLON/react-native-confetti-cannon.svg?style=svg)](https://circleci.com/gh/VincentCATILLON/react-native-confetti-cannon)
![https://img.shields.io/npm/v/react-native-confetti-cannon/latest?color=%23292C33&label=%20&logo=npm](https://img.shields.io/npm/v/react-native-confetti-cannon/latest?color=%23292C33&label=%20&logo=npm)
![https://img.shields.io/badge/Platforms-iOS%20%7C%C2%A0Android%20%7C%20Web-blue](https://img.shields.io/badge/Platforms-iOS%20%7C%C2%A0Android%20%7C%20Web-blue)
![https://img.shields.io/github/stars/vincentcatillon/react-native-confetti-cannon?style=social](https://img.shields.io/github/stars/vincentcatillon/react-native-confetti-cannon?style=social)

## Installation

Expand Down Expand Up @@ -36,6 +38,19 @@ const MyComponent = () => (
| onAnimationStart | (Array<Item>): void | callback triggered at animation start | | |
| onAnimationEnd | (Array<Item>): void | callback triggered at animation end | | |

## Try yourself

Deep into the `example` folder and run:

```console
npm install && npm start
```

And choose one of the following Expo commands:
- `i`: open in iOS simulator
- `a`: open in Android emulator
- `w`: open in web browser

## :warning: Warning

It is strongly recommended to use 1.2.0 or higher to avoid this warning introduced in [React-Native 0.62](https://github.com/react-native-community/releases/blob/master/CHANGELOG.md#deprecated):
Expand Down

0 comments on commit 0b6421d

Please sign in to comment.