Overview
The document provides instructions for adding a library to the React Native Directory on GitHub. It includes details on the required fields and format for submitting a pull request to improve the directory’s dataset or report a bug.
Features
- General Fields: Includes githubUrl, npmPkg, nameOverride, examples, and images for the library entry.
- Platform Compatibility: Indicates whether the library works on Android, iOS, web, or as part of Expo Go.
- Out-of-tree Platforms: Specifies support for additional platforms like Windows, MacOS, tvOS, and visionOS.
- Tags: Tags like unmaintained, dev, template, and newArchitecture to provide additional information about the library.
Installation
To add a library to the React Native Directory, follow these steps:
- Add the library at the end of the
react-native-libraries.json
file. - Maintain the order in the file for the “Recently added” sort option.
- Submit a pull request with the changes.
Summary
The document provides a structured format for adding a library to the React Native Directory on GitHub, ensuring consistency and completeness in the dataset. It outlines the required fields, platform compatibility, tags, and formatting guidelines for submitting a pull request to enhance the directory’s information.