Skip to content

Commit 25af297

Browse files
committed
chore: preparation before publishing
1 parent c65de94 commit 25af297

File tree

4 files changed

+70
-4
lines changed

4 files changed

+70
-4
lines changed
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: kirillzyusko
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Code snippet**
14+
Add your code snippet where error has been occurred.
15+
16+
**Repo for reproducing**
17+
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.
18+
19+
**To Reproduce**
20+
Steps to reproduce the behavior:
21+
1. Go to '...'
22+
2. Click on '....'
23+
3. Scroll down to '....'
24+
4. See error
25+
26+
**Expected behavior**
27+
A clear and concise description of what you expected to happen.
28+
29+
**Screenshots**
30+
If applicable, add screenshots to help explain your problem.
31+
32+
**Smartphone (please complete the following information):**
33+
- Desktop OS [e.g. Windows 10, MacOS 10.15.5]
34+
- Device: [e.g. iPhone6]
35+
- OS: [e.g. iOS 8.1]
36+
- JS engine [e.g. JSC, Hermes, v8]
37+
- Library version [e.g. 22]
38+
39+
**Additional context**
40+
Add any other context about the problem here.
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: Feature
6+
assignees: kirillzyusko
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# react-native-keyboard-controller
22

3-
Platform agnostic keyboard manager
3+
Keyboard manager which works in identical way on both iOS and Android.
4+
5+
> **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 🙂.
46
57
## Demonstration
68

@@ -15,12 +17,16 @@ Platform agnostic keyboard manager
1517
- reanimated support 🚀
1618
- interactive keyboard dismissing (planned) 👆📱
1719
- and more is coming... Stay tuned! 😊
20+
1821
## Installation
1922

20-
The module is not available on `npm`, but you can install it from github.
23+
Install `react-native-keyboard-controller` package from npm:
2124

2225
```sh
23-
yarn add https://github.com/kirillzyusko/react-native-keyboard-controller
26+
yarn add react-native-keyboard-controller
27+
28+
# or
29+
# npm install react-native-keyboard-controller --save
2430
```
2531

2632
## Usage

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "react-native-keyboard-controller",
3-
"version": "0.1.0",
3+
"version": "1.0.0-alpha.0",
44
"description": "Platform agnostic keyboard manager",
55
"main": "lib/commonjs/index",
66
"module": "lib/module/index",

0 commit comments

Comments
 (0)