From 0b6421deaa2a29854f84ecf6e58f86293f4c97fe Mon Sep 17 00:00:00 2001 From: Vincent Catillon Date: Thu, 30 Apr 2020 18:12:50 +0200 Subject: [PATCH] Readme enhancement (#25) * Add some badges * Add example section * Add PR template --- .github/PULL_REQUEST_TEMPLATE.md | 30 ++++++++++++++++++++++++++++++ README.md | 17 ++++++++++++++++- 2 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..337c704 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -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. + + + + + + + + + + + + + + +
BeforeAfter
+ __WIP__ + + __WIP__ +
+ +### Related issues + +- [ ] [Is there any issue ?](https://github.com/VincentCATILLON/react-native-confetti-cannon/issues/1337) diff --git a/README.md b/README.md index 634d617..0162c68 100644 --- a/README.md +++ b/README.md @@ -2,8 +2,10 @@ React-native-confetti-cannon

-![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 @@ -36,6 +38,19 @@ const MyComponent = () => ( | onAnimationStart | (Array): void | callback triggered at animation start | | | | onAnimationEnd | (Array): 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):