Skip to content

Commit cd8cb80

Browse files
authored
docs: use documentation installation page in README (#879)
## 📜 Description Replace installation instructions with a docs guide. ## 💡 Motivation and Context We still ahve to keep people aware, that reanimated is a mandatory dependency, that people need to wrap app in Provider, separate instructions for Expo, etc. So let's use a single source of truth in documentation and just use link to docs in README. Closes #877 ## 📢 Changelog <!-- High level overview of important changes --> <!-- For example: fixed status bar manipulation; added new types declarations; --> <!-- If your changes don't affect one of platform/language below - then remove this platform/language --> ### Docs - use link to docs for installation step; - removed "our" in documentation details; - use "information" instead of "info"; ## 🤔 How Has This Been Tested? Tested via preview. ## 📸 Screenshots (if appropriate): <img width="1041" alt="image" src="https://github.com/user-attachments/assets/77043ef7-5034-4653-8f63-672d6c251214" /> ## 📝 Checklist - [x] CI successfully passed - [x] I added new mocks and corresponding unit-tests if library API was changed
1 parent bb84dcb commit cd8cb80

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,11 @@ Keyboard manager which works in identical way on both iOS and Android.
2222

2323
## Installation
2424

25-
Install `react-native-keyboard-controller` package from npm:
26-
27-
```shell
28-
yarn add react-native-keyboard-controller
29-
# or
30-
npm install react-native-keyboard-controller --save
31-
```
25+
Check out the [installation](https://kirillzyusko.github.io/react-native-keyboard-controller/docs/installation) section of docs for the detailed installation instructions.
3226

3327
## Documentation
3428

35-
Check out our dedicated documentation page for info about this library, API reference and more: [https://kirillzyusko.github.io/react-native-keyboard-controller/](https://kirillzyusko.github.io/react-native-keyboard-controller/)
29+
Check out the dedicated documentation page for information about this library, API reference and more: [https://kirillzyusko.github.io/react-native-keyboard-controller/](https://kirillzyusko.github.io/react-native-keyboard-controller/)
3630

3731
## Contributing
3832

0 commit comments

Comments
 (0)