Skip to content

Commit 0c03416

Browse files
README updated and included in npm package (#302)
* Update and align badges * Use HTML syntax to justify header and badges * Put all example images into one table * Describe installation and usage of the library The "Installation & Usage" section describes how to install the library using `yarn` or `npm` and what are the special cases for iOS and Web versions of this lib. The Example has been made from combination of Example section, Web, and Getting Started section. * Present properties in a table instead of sections To keep the README minimal and easy to read the Properties section has been converted into a table with all columns related to: Prop name, Description, Type, Required, Platform (filled only if needed) This also makes the props agenda unnecessary as scrolling through the agenda is more or less the same as scrolling through the table. * Improve the layout of the props table * Move the migration note to Installation & Usage * Remove manual linking section The idea is to avoid using manual linking of this library on Windows. The component should correctly link automaticaly. Moreover: manual linking was only neccessary on RNv0.62 and lower, so there's no need to extend the README with this. * Simplify the Contributing section * Request for platform when opening an issue * Include footer with Callstack open source * Remove redundant info about License * Make a link to contributors graph * Include the README in the npmjs package * Update version to 4.1.3
1 parent e835a79 commit 0c03416

File tree

3 files changed

+272
-328
lines changed

3 files changed

+272
-328
lines changed

0 commit comments

Comments
 (0)