diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bde20c9..97edde6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -140,6 +140,8 @@ The `package.json` file contains various scripts for common tasks: When you're sending a pull request: +- **Always open pull requests against the `dev` branch.** + Pull requests targeting `main` will be closed. - Prefer small pull requests focused on one change. - Verify that linters and tests are passing. - Review the documentation to make sure it looks good. diff --git a/README.md b/README.md index a09bd2b..9e49c26 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,14 @@ React-native wrapper for android & IOS google maps sdk ## Installation ```sh -npm install react-native-google-maps-plus react-native-nitro-modules +yarn add react-native-google-maps-plus react-native-nitro-modules > `react-native-nitro-modules` is required as this library relies on [Nitro Modules](https://nitro.margelo.com/). ``` ## Usage -```js -import { GoogleMapsNitroView } from 'react-native-google-maps-plus'; - -// ... -; -``` +Checkout the example app in the [example](./example) folder. ## Contributing