Example app's readme.md#1452
Conversation
kirillzyusko
left a comment
There was a problem hiding this comment.
Hey @yairopro
Thank you for your PR. The changes looks solid, most of these instructions are already mentioned in https://github.com/kirillzyusko/react-native-keyboard-controller/blob/main/CONTRIBUTING.md
But I understand that people may ignore it so I like your changes, thank you very much for your contribution!
But I'd like to make few changes (I described it in comments). Additionally - could you please make your changes in FabricExample too?
At the moment I support both architectures, but at some point of time I'll simply remove example folder and rename FabricExample to example and I don't want to loose these changes 🙏
| <img src="./screenshot.png" align="left" width="300" style="margin-right: 20px;"> | ||
|
|
||
| # Example | ||
|
|
There was a problem hiding this comment.
Can we add another subheader, like Run the app or something like this?
| ```bash | ||
| # first install dependencies of the repository | ||
| # at the parent folder | ||
| yarn |
There was a problem hiding this comment.
I'd like to see it as individual sections, like
- install dependencies of the repository at the parent folder
yarn - Install dependencies of example app
cd example
yarn- Run metro server
yarn start- Run example app (open
examplefolder in a new terminal and then run):
yarn android
yarn ios| yarn android | ||
| # or | ||
| yarn ios | ||
| ``` |
There was a problem hiding this comment.
Maybe in the end of it we can add a section like "Contributing guide"? And add a link to https://github.com/kirillzyusko/react-native-keyboard-controller/blob/main/CONTRIBUTING.md
Smth like this
## Contributing guide
If you discovered a bug and know the fix or would like to make a contribution to the project, please check [contribution guide](https://github.com/kirillzyusko/react-native-keyboard-controller/blob/main/CONTRIBUTING.md).
|
@kirillzyusko "Fabric" is react-native new arch? (I am sorry I did not read the Contributing doc before (I just did 😅 now)). |
|
Yes @yairopro But the idea with README in the example folder is good! 😊 |
📊 Package size report
|


📜 Description
example/README.mdwith ascreenshot.pngto help how to run the example app.💡 Motivation and Context
I was not able to run the example app instinctively: #1451
Closes #1451
📢 Changelog
Just doc.
🤔 How Has This Been Tested?
Yes, I managed to read it. XD
📸 Screenshots (if appropriate):
📝 Checklist