Skip to content

Example app's readme.md#1452

Merged
kirillzyusko merged 7 commits into
kirillzyusko:mainfrom
yairopro:feat/example-readme
May 15, 2026
Merged

Example app's readme.md#1452
kirillzyusko merged 7 commits into
kirillzyusko:mainfrom
yairopro:feat/example-readme

Conversation

@yairopro
Copy link
Copy Markdown
Contributor

@yairopro yairopro commented May 8, 2026

📜 Description

  • added a example/README.md with a screenshot.png to 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):

image

📝 Checklist

  • CI successfully passed
  • I added new mocks and corresponding unit-tests if library API was changed

@kirillzyusko kirillzyusko self-assigned this May 8, 2026
@kirillzyusko kirillzyusko added documentation Improvements or additions to documentation example Anything related to example project labels May 8, 2026
Copy link
Copy Markdown
Owner

@kirillzyusko kirillzyusko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 🙏

Comment thread example/README.md
<img src="./screenshot.png" align="left" width="300" style="margin-right: 20px;">

# Example

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we add another subheader, like Run the app or something like this?

Comment thread example/README.md Outdated
Comment on lines +5 to +8
```bash
# first install dependencies of the repository
# at the parent folder
yarn
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to see it as individual sections, like

  1. install dependencies of the repository at the parent folder
yarn 
  1. Install dependencies of example app
cd example
yarn
  1. Run metro server
yarn start
  1. Run example app (open example folder in a new terminal and then run):
yarn android
yarn ios

Comment thread example/screenshot.png Outdated
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would it be possible to:

  • remove black corners and make them transparent
  • add more space between the image and text? At the moment it looks very close to each other
Image

Maybe 40px would be better?

Comment thread example/README.md
yarn android
# or
yarn ios
```
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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).

@yairopro
Copy link
Copy Markdown
Contributor Author

yairopro commented May 10, 2026

@kirillzyusko "Fabric" is react-native new arch?

(I am sorry I did not read the Contributing doc before (I just did 😅 now)).

@kirillzyusko
Copy link
Copy Markdown
Owner

Yes @yairopro

But the idea with README in the example folder is good! 😊

@kirillzyusko kirillzyusko self-requested a review May 15, 2026 15:23
@github-actions
Copy link
Copy Markdown
Contributor

📊 Package size report

Current size Target Size Difference
317460 bytes 317460 bytes 0 bytes 📉

@kirillzyusko
Copy link
Copy Markdown
Owner

The updated version looks like this:

image

@kirillzyusko kirillzyusko merged commit 7dcd70a into kirillzyusko:main May 15, 2026
16 of 17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation example Anything related to example project

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Unable to run the example app

2 participants