Skip to content

Commit

Permalink
chore: preparation before publishing
Browse files Browse the repository at this point in the history
  • Loading branch information
kirillzyusko committed May 1, 2022
1 parent c65de94 commit 25af297
Show file tree
Hide file tree
Showing 4 changed files with 70 additions and 4 deletions.
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down

0 comments on commit 25af297

Please sign in to comment.