diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..289e815b9f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,40 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: kirillzyusko + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Code snippet** +Add your code snippet where error has been occurred. + +**Repo for reproducing** +I would be highly appreciate if you can provide repository for reproducing your issue. It can significantly reduce the time for discovering and fixing the problem. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Smartphone (please complete the following information):** + - Desktop OS [e.g. Windows 10, MacOS 10.15.5] + - Device: [e.g. iPhone6] + - OS: [e.g. iOS 8.1] + - JS engine [e.g. JSC, Hermes, v8] + - Library version [e.g. 22] + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..fcb7292e1b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: Feature +assignees: kirillzyusko + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/README.md b/README.md index 8387d94900..2d99557bce 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ # react-native-keyboard-controller -Platform agnostic keyboard manager +Keyboard manager which works in identical way on both iOS and Android. + +> **Note**: This library is still in development and in `alpha` stage. So most likely it has bugs/issues - don't hesitate to report if you find them 🙂. ## Demonstration @@ -15,12 +17,16 @@ Platform agnostic keyboard manager - reanimated support 🚀 - interactive keyboard dismissing (planned) 👆📱 - and more is coming... Stay tuned! 😊 + ## Installation -The module is not available on `npm`, but you can install it from github. +Install `react-native-keyboard-controller` package from npm: ```sh -yarn add https://github.com/kirillzyusko/react-native-keyboard-controller +yarn add react-native-keyboard-controller + +# or +# npm install react-native-keyboard-controller --save ``` ## Usage diff --git a/package.json b/package.json index 30dbdcea21..eabb319eeb 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-native-keyboard-controller", - "version": "0.1.0", + "version": "1.0.0-alpha.0", "description": "Platform agnostic keyboard manager", "main": "lib/commonjs/index", "module": "lib/module/index",