Skip to content

Commit eca2eeb

Browse files
committed
chore: update README.md
1 parent 3b4fbef commit eca2eeb

File tree

1 file changed

+48
-12
lines changed

1 file changed

+48
-12
lines changed

README.md

Lines changed: 48 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -101,32 +101,68 @@ Expo projects should use the config plugin instead (see Expo section above).
101101

102102
See the official [Google Maps Android SDK configuration guide](https://developers.google.com/maps/documentation/android-sdk/config#step_3_add_your_api_key_to_the_project) for more details.
103103

104-
---
105-
106104
### iOS
107105

108106
**Note:** These instructions apply to **bare React Native apps only**.
109107
Expo projects should use the config plugin instead (see Expo section above).
110108

111109
See the official [Google Maps iOS SDK configuration guide](https://developers.google.com/maps/documentation/ios-sdk/config#get-key) for more details.
112110

113-
---
111+
## Dependencies & Native Documentation
112+
113+
This package is React Native wrapper around the official Google Maps SDKs.
114+
For full API behavior, configuration options, and feature reference, please consult the native documentation:
115+
116+
- **iOS Google Maps SDK**
117+
https://developers.google.com/maps/documentation/ios-sdk
114118

115-
# Dependencies
119+
- **Android Google Maps SDK**
120+
https://developers.google.com/maps/documentation/android-sdk
116121

117-
This package builds on native libraries for SVG rendering and Google Maps integration:
122+
- **Maps Utility Libraries (iOS & Android)**
123+
https://developers.google.com/maps/documentation/ios-sdk/utility
124+
https://developers.google.com/maps/documentation/android-sdk/utility
118125

119-
- **iOS**: [SVGKit](https://github.com/SVGKit/SVGKit)
120-
- **Android**: [AndroidSVG](https://bigbadaboom.github.io/androidsvg/)
121-
- **iOS Maps SDK**: [Google Maps SDK for iOS](https://developers.google.com/maps/documentation/ios-sdk)
122-
- **Android Maps SDK**: [Google Maps SDK for Android](https://developers.google.com/maps/documentation/android-sdk)
123-
- **Maps Utility Libraries**: [Google Maps Utils for iOS](https://developers.google.com/maps/documentation/ios-sdk/utility) and [Google Maps Utils for Android](https://developers.google.com/maps/documentation/android-sdk/utility)
126+
- **SVG Rendering** (used for custom marker icons)
127+
- iOS: https://github.com/SVGKit/SVGKit
128+
- Android: https://bigbadaboom.github.io/androidsvg/
124129

125-
These are automatically linked when you install the package, but you may need to clean/rebuild your native projects after first install.
130+
These libraries are automatically linked during installation.
131+
If you encounter build issues, try cleaning and rebuilding your native project.
132+
133+
> **Note:** This package follows the native SDKs closely. Props and behavior match the underlying Google Maps APIs whenever possible.
126134
127135
## Usage
128136

129-
Checkout the example app in the [example](./example) folder.
137+
Basic map:
138+
139+
```tsx
140+
import React from 'react';
141+
import { GoogleMapsView } from 'react-native-google-maps-plus';
142+
143+
export default function App() {
144+
return (
145+
<GoogleMapsView
146+
style={{ flex: 1 }}
147+
initialProps={{
148+
camera: {
149+
center: { latitude: 37.7749, longitude: -122.4194 },
150+
zoom: 12,
151+
},
152+
}}
153+
markers={[
154+
{
155+
id: '1',
156+
zIndex: 1,
157+
coordinate: { latitude: 37.7749, longitude: -122.4194 },
158+
},
159+
]}
160+
/>
161+
);
162+
}
163+
```
164+
165+
Check out the example app in the [example](./example) folder.
130166

131167
## Contributing
132168

0 commit comments

Comments
 (0)