Skip to content

Commit

Permalink
fix: typo on README.md (#278)
Browse files Browse the repository at this point in the history
## 📜 Description

Removed `#` to make installation instructions more explicit.

## 💡 Motivation and Context

Commented out code hard to read and notice.

Also added tabs for selection package manager in documentation.

## 📢 Changelog

### Docs
- removed `#` to make installation instructions more explicit in README;
- added npm/yarn tabs.

## 🤔 How Has This Been Tested?

Tested via preview on `localhost:3000` and github preview.

## 📸 Screenshots (if appropriate):

<img width="1003" alt="image"
src="https://github.com/kirillzyusko/react-native-keyboard-controller/assets/22820318/fc32802a-7ac1-438c-9cab-182ce16c1b03">

## 📝 Checklist

- [ ] CI successfully passed

---------

Co-authored-by: kirillzyusko <zyusko.kirik@gmail.com>
  • Loading branch information
bekroz and kirillzyusko committed Nov 17, 2023
1 parent c48c3ce commit 96175ed
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 8 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ Keyboard manager which works in identical way on both iOS and Android.

Install `react-native-keyboard-controller` package from npm:

```sh
```shell
yarn add react-native-keyboard-controller
# or
# npm install react-native-keyboard-controller --save
npm install react-native-keyboard-controller --save
```

## Documentation
Expand Down
20 changes: 17 additions & 3 deletions docs/docs/installation.md → docs/docs/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,32 @@ description: Guide dedicated to installation process
keywords: [react-native-keyboard-controller, react-native keyboard, installation, setup, keyboard handling, keyboard animation, keyboard movement, troubleshooting]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Installation

## Adding a library to the project

Install the `react-native-keyboard-controller` package in your React Native project.

```bash
<Tabs>
<TabItem value="yarn" label="YARN" default>

```shell
yarn add react-native-keyboard-controller
# or with npm
# npm install react-native-keyboard-controller --save
```

</TabItem>
<TabItem value="npm" label="NPM">

```shell
npm install react-native-keyboard-controller --save
```

</TabItem>
</Tabs>

### Linking

This package supports [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,32 @@ description: Guide dedicated to installation process
keywords: [react-native-keyboard-controller, react-native keyboard, installation, setup, keyboard handling, keyboard animation, keyboard movement, troubleshooting]
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Installation

## Adding a library to the project

Install the `react-native-keyboard-controller` package in your React Native project.

```bash
<Tabs>
<TabItem value="yarn" label="YARN" default>

```shell
yarn add react-native-keyboard-controller
# or with npm
# npm install react-native-keyboard-controller --save
```

</TabItem>
<TabItem value="npm" label="NPM">

```shell
npm install react-native-keyboard-controller --save
```

</TabItem>
</Tabs>

### Linking

This package supports [autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md).
Expand Down

0 comments on commit 96175ed

Please sign in to comment.