diff --git a/packages/react-native-gradle-plugin/README.md b/packages/react-native-gradle-plugin/README.md new file mode 100644 index 00000000000..dbe677a5740 --- /dev/null +++ b/packages/react-native-gradle-plugin/README.md @@ -0,0 +1,16 @@ +# react-native-gradle-plugin + +[![Version][version-badge]][package] + +A Gradle Plugin used to support development of React Native applications for Android. + +## Installation + +``` +yarn add react-native-gradle-plugin +``` + +*Note: We're using `yarn` to install deps. Feel free to change commands to use `npm` 3+ and `npx` if you like* + +[version-badge]: https://img.shields.io/npm/v/react-native-gradle-plugin?style=flat-square +[package]: https://www.npmjs.com/package/react-native-gradle-plugin diff --git a/packages/react-native-gradle-plugin/package.json b/packages/react-native-gradle-plugin/package.json index 535f7ddd24c..25cdbff2b96 100644 --- a/packages/react-native-gradle-plugin/package.json +++ b/packages/react-native-gradle-plugin/package.json @@ -20,7 +20,8 @@ "gradle", "gradlew", "gradlew.bat", - "src" + "src", + "README.md" ], "dependencies": { "react-native-codegen": "*"