Suggestion - Update Readme with more information
See original GitHub issueHi,
I’m interested in using this package, but I’m a little wary of implementing it since the readme is kind of light on details.
For instance, does this work with all android and ios devices with notches? What does this package actually do? (description of how it works) Will this be actively maintained? How does this handle devices without notches?
If you could add a bit more to the readme I think that would help people to decide on using this. It’s coming recommended from @mikehardy via react-native-device-info as a replacement for their hasNotch method, so maybe adding that could also help?
Issue Analytics
- State:
- Created 4 years ago
- Comments:5 (2 by maintainers)
Top Results From Across the Web
Suggested Edits - ReadMe Documentation
Suggested edits are a way for your community to let you know when they think a doc is out of date or could...
Read more >[Suggestion] Update "Major Updates" section in docs ... - GitHub
https://github.com/s-yadav/react-number-format#major-updates. I would like to propose adding more information about the breaking change on ...
Read more >README.md template | Documenting your project - Drupal
Log in, click Edit, and edit this page; Log in, click Discuss, update the Page status value, and suggest an improvement; Log in...
Read more >Guide to writing "readme" style metadata
Guide to writing "readme" style metadata · General information · Data and file overview · Sharing and access information · Methodological information ·...
Read more >Make a README
A README is a text file that introduces and explains a project. It contains information that is commonly required to understand what the...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

@janicduplessis this is spilling over from discussion on react-native-device-info
@rtman here is the previous thread: https://github.com/react-native-community/react-native-device-info/issues/594#issuecomment-527669853
It does not exist yet but we are thinking it is possible to expose it so then you can answer the boolean “hasNotch” question
Going to close this, if anyone (or myself when I get time) wants to add more details to the readme feel free to open a PR.