@rnmapbox/maps 10.0.0-beta.28

package/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish to NPM
+on:
+  release:
+    types: [created]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Read .nvmrc
+        run: echo ::set-output name=NVMRC::$(cat .nvmrc)
+        id: nvm
+      - name: Setup node ${{ steps.nvm.outputs.NVMRC }}
+        uses: actions/setup-node@v2.5.0
+        with:
+          node-version: ${{ steps.nvm.outputs.NVMRC }}
+          registry-url: https://registry.npmjs.org/
+      - name: Setup Node
+        uses: actions/setup-node@v2
+        with:
+          node-version: '14.x'
+          registry-url: 'https://registry.npmjs.org'
+      - name: Install dependencies and build 🔧
+        run: npm install --force
+      - name: Publish package on NPM 📦
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_PUBLISH_TOKEN_RNMAPBOX }}

package/.nvmrc

@@ -0,0 +1,2 @@
+v14.17.0
+

package/.prettierrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  singleQuote: true,
+  trailingComma: 'all',
+};

package/.sonarcloud.properties

@@ -0,0 +1,15 @@
+# Path to sources
+sonar.sources=javascript,android/src,ios/RCTMGL
+#sonar.exclusions=
+#sonar.inclusions=
+
+# Path to tests
+sonar.tests=__tests__
+#sonar.test.exclusions=
+#sonar.test.inclusions=
+
+# Source encoding
+#sonar.sourceEncoding=UTF-8
+
+# Exclusions for copy-paste detection
+#sonar.cpd.exclusions=

package/CHANGELOG.md

@@ -0,0 +1,386 @@
+## UNRELEASED
+
+```
+Please add unreleased changes in the following style:
+PR Title ([#123](link to my pr))
+```
+
+### UNRELEASED/10.0.0-beta.10
+
+#### Breaking changes:
+
+The setup was changed - see install instructions for more details. In a nuthsell:
+* On both android/ios to select mapbox implementation use `RNMapboxMapsImpl`/`$RNMapboxMapsImpl` variable which can be one of (`maplibre`,`mapbox`(aka v10),`mapbox-gl`)
+* Default implementation is `maplibre` as it requires not further setup. *WARNING* using mapbox styles from `maplibre` has different pricing than mapbox native sdk-s.
+* On Podfile `$RNMBGL.(pre|post)_install` was changed `$RNMapboxMaps.(pre|post)_install`
+* Package name was changed from `@react-native-mapbox-gl/maps` to `@rnmapbox/maps`. If you just testing with the v10 version you can use something like [babel-plugin-transform-rename-import](https://www.npmjs.com/package/babel-plugin-transform-rename-import) to keep using the old imports for a while.
+* `MapboxGL.setAccessToken` now requires `MapboxGL.setWellKnownTileServer` on maplibre.
+
+
+#### Changes:
+
+- Convert Camera component to TypeScript and update related documentation generation and tests ([#2057](https://github.com/rnmapbox/maps/pull/2057))
+- Implement clustering properties to ShapeSource ([#1745](https://github.com/react-native-mapbox-gl/maps/pull/1745))
+- Initial Mapbox V10 support ([#1750](https://github.com/rnmapbox/maps/pull/1750))
+- Updated MapLibre on Android to 9.5.2 ([#1780](https://github.com/rnmapbox/maps/pull/1780))
+
+## 8.6.0-beta.0
+
+fix: add TypeScript type for MapViews's preferredFramesPerSecond prop ([#1717](https://github.com/rnmapbox/maps/pull/1717))
+fix(example): update `/example` project (iOS only) to work with ARM-based Macs ([#1703](https://github.com/rnmapbox/maps/pull/1703))
+fix(iOS): correct import of UIView+React.h header ([#1672](https://github.com/rnmapbox/maps/pull/1672))
+
+---
+
+## 8.5.0
+
+build: update install guide and `/example` project for android dependencies ([#1640](https://github.com/rnmapbox/maps/pull/1640))
+build(turf): update to version 6.5.0 ([#1638](https://github.com/rnmapbox/maps/pull/1638))
+fix(Camera) fix `zoomTo` method and expand Fit example ([#1631](https://github.com/rnmapbox/maps/pull/1631))
+ci: two scripts for linting with and without fix ([#1630](https://github.com/rnmapbox/maps/pull/1630))
+feat(Camera) add an optional `allowUpdates` boolean prop ([#1619](https://github.com/rnmapbox/maps/pull/1619))
+refactor(example): remove unused modules and scripts ([#1618](https://github.com/rnmapbox/maps/pull/1618))
+fix(react-native): update api to get rid of EventEmitter warnings ([#1615](https://github.com/rnmapbox/maps/pull/1615))
+fix(Camera) persist zoom when changing from `bounds` to `centerCoordinate`, fix zero padding not causing map to update, create unified example showcasing bounds/centerCoordinate/zoom/padding ([#1614](https://github.com/rnmapbox/maps/pull/1614))
+Update MapLibre to 5.12.1 on iOS ([#1596](https://github.com/rnmapbox/maps/pull/1596))
+Update ShapeSource methods to make it usable with any cluster ( Use cluster itself instead of cluster_id as first argument for getClusterExpansionZoom/getClusterLeaves/getClusterChildren methods. Version < 9 methods still supports passing cluster_id as a first argument but a deprecation warning will be shown. ) ([#1499](https://github.com/rnmapbox/maps/pull/1499))
+
+---
+
+## 8.4.0
+
+fix(iOS): pin mapLibre back to `5.12.0` ([#1589](https://github.com/rnmapbox/maps/pull/1589))
+chore: improve GH workflows ([#1588](https://github.com/rnmapbox/maps/pull/1588))
+build(deps): bump @expo/config-plugins from 3.1.0 to 4.0.3 ([#1585](https://github.com/rnmapbox/maps/pull/1585))
+chore(pre-commit): run lint on TS files, change PR template ([#1584](https://github.com/rnmapbox/maps/pull/1584))
+feat(example): update vertical alignment example ([#1579](https://github.com/rnmapbox/maps/pull/1579))
+fix incorrect anchor calculation for PointAnnotation on iOS ([#1576](https://github.com/rnmapbox/maps/pull/1576))
+style(eslint): align root and example with the same configuration ([#1575](https://github.com/rnmapbox/maps/pull/1575))
+fix(mapLibre): support version `5.12.0` upwards ([#1571](https://github.com/rnmapbox/maps/pull/1571))
+build: upgrade to RN `0.66` ([#1570](https://github.com/rnmapbox/maps/pull/1570))
+build(android): add telemetry dependency to default build setup ([#1550](https://github.com/rnmapbox/maps/pull/1550))
+feat(camera): Enable `padding` as a root-level prop on the camera, with `bounds.padding*` as fallbacks ([#1538](https://github.com/rnmapbox/maps/pull/1538/files))
+fix: revert pinned mapLibre version to `5.11.0` ([8a2b00e67ba6398f3f6e6f52e98b0f0cea437e4d](https://github.com/rnmapbox/maps/commit/8a2b00e67ba6398f3f6e6f52e98b0f0cea437e4d))
+
+---
+
+## 8.3.0
+
+Fix TypeScript type for Callout's textStyle prop ([#1450](https://github.com/rnmapbox/maps/pull/1450))
+Build(ios): pin maplibre version to 5.12.0 ([#1454](https://github.com/rnmapbox/maps/pull/1454))
+Update geoUtils helpers types to correspond with `turf/helpers` ([#1455](https://github.com/rnmapbox/maps/pull/1455))
+Fix crash with missing okhttp dependency ([#1452](https://github.com/rnmapbox/maps/pull/1452))
+Move from react-native-testing-library => @testing-library/react-native ([#1453](https://github.com/rnmapbox/maps/pull/1453))
+Feat(camera): maxBounds/(min|max)ZoomLevel can be updated dynamically ([#1462](https://github.com/rnmapbox/maps/pull/1462))
+Refactor(example): clean up folder structure ([#1464](https://github.com/rnmapbox/maps/pull/1464))
+Fix lineGradient showing wrong colors ([#1471](https://github.com/rnmapbox/maps/pull/1471))
+Support tintColor on Android ([#1465](https://github.com/rnmapbox/maps/pull/1465))
+Feat(android): dynamically update tintColor & add example ([#1469](https://github.com/rnmapbox/maps/pull/1469)
+Examples: align install steps with yarn, ignore created env files ([#1484](https://github.com/rnmapbox/maps/pull/1484)
+Fix(plugin): Exclude arm64 architectures for simulator builds ([#1490](https://github.com/rnmapbox/maps/pull/1490)
+Feat(android): dynamically update tintColor & add example ([#1469](https://github.com/rnmapbox/maps/pull/1469))
+Docs: make background in example pngs transparent ([#1483](https://github.com/rnmapbox/maps/pull/1483))
+Style: run yarn lint ([#1486](https://github.com/rnmapbox/maps/pull/1486))
+Test: add unit tests for component light ([#1489](https://github.com/rnmapbox/maps/pull/1489))
+Feat: add Adds getClusterChildren method to ShapeSource ([#1495](https://github.com/rnmapbox/maps/pull/1495))
+
+## 8.2.1
+
+fix issue when publishing to npm with `prepare` script
+
+## 8.2.0
+
+getClusterLeaves method for ShapeSource ([#1411](https://github.com/rnmapbox/maps/pull/1411))
+Add logoPosition props to `MapView` to position the mapbox logo ([#1396](https://github.com/rnmapbox/maps/pull/1396))
+Add compatibility with React 17/ npm7 ([#1387](https://github.com/rnmapbox/maps/pull/1387))
+Add Expo config plugin ([#1388](https://github.com/rnmapbox/maps/pull/1388))
+Android: Bump `okhttp` to `4.9.0` ([#1390](https://github.com/rnmapbox/maps/pull/1390))
+Support dynamically changing local JSON in styleURL ([#1399](https://github.com/rnmapbox/maps/pull/1399))
+Add missing types to `SymbolLayerStyle` & `ImagesProps` ([#1360](https://github.com/rnmapbox/maps/pull/1360))
+Fix error while updating coordinates of RCTMGLImageSource ([#1310](https://github.com/rnmapbox/maps/pull/1310))
+
+## 8.2.0-beta2
+
+Add types for `Logger` class ([#1316](https://github.com/rnmapbox/maps/pull/1316))
+Enable linear easing on map camera ([#1281](https://github.com/rnmapbox/maps/pull/1281))
+Allow MapLibre as an option ([#1311](https://github.com/rnmapbox/maps/pull/1311))
+Fix native UserLocation on Android ([#1284](https://github.com/rnmapbox/maps/pull/1284))
+Add getClusterExpansionZoom to ShapeSource ([#1279](https://github.com/rnmapbox/maps/pull/1279))
+Add type definition for AnimatedPoint ([#1280](https://github.com/rnmapbox/maps/pull/1280))
+
+## 8.2.0-beta1
+
+### Breaking changes:
+
+Use `pre_install` hook to support non `use_frameworks!` usage #1262. Please add the following to your `Podfile`:
+
+```ruby
+pre_install do |installer|
+  $RNMBGL.pre_install(installer)
+  ...
+end
+```
+
+and
+
+```ruby
+post_install do |installer|
+  $RNMBGL.post_install(installer)
+  ...
+end
+```
+
+### Other changes:
+
+- Add course to the location events #1209
+- Fix heading indicator alignment #1215
+- App crash when ProGuard is set to true #1184
+- [iOS] Implemented ShapeSource.features(...) method #1140
+- style json support on styleURL #1102
+- Fix: onUpdate not called when renderMode is native #1135
+
+## 8.1.0
+
+- By default [use 5.9.0 Mapbox on iOS as 8.1.0rc8 and before](https://github.com/rnmapbox/maps/pull/1120)
+- Fix [crash during styleURL change on adroid](https://github.com/rnmapbox/maps/pull/1119)
+- Fix [warning Sending LogEvent with no listeners registered.](https://github.com/rnmapbox/maps/pull/1108)
+- Fix [race in close map and icon image download](https://github.com/rnmapbox/maps/pull/1089)
+- Fix [android padding](https://github.com/rnmapbox/maps/pull/1087)
+- Android [custom mapboxgl version](https://github.com/rnmapbox/maps/pull/1088)
+- Fix [support 6.\* of MapboxGL IOS by setting `$ReactNativeMapboxGLIOSVersion = "6.2.1"` in Podfile](https://github.com/rnmapbox/maps/pull/1044)
+- Fix [map rendered at (0,0,0,0) on iOS](https://github.com/rnmapbox/maps/pull/1084)
+- Fix [edge Padding + auto limit padding on iOS](https://github.com/rnmapbox/maps/pull/1057)
+- Fix [coordinate 0,0 was considered invalid on IOS](https://github.com/rnmapbox/maps/pull/1076)
+- Fix [refresh on PointAnnotation on Android](https://github.com/rnmapbox/maps/pull/1062)
+- Fix [Image source coordinates update on the fly](https://github.com/rnmapbox/maps/pull/1036/files)
+- Upgrade to [ios 5.9.0](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v5.9.0)
+- Upgrade to [android 9.1.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v9.1.0)
+- Set default Mapbox logging verbosity to warning. (Change it using Logger.setLogLevel('verbose'))
+- Error/Warn mapbox log messages are treated as redbox/yellowbox errors/warnings. (Override it using Logger.setLoggerCallback(log => { return true })
+- Native user location [#825](https://github.com/rnmapbox/maps/pull/825)
+
+## 8.1.0-rc11
+
+- By default [use 5.9.0 Mapbox on iOS as 8.1.0rc8 and before](https://github.com/rnmapbox/maps/pull/1120)
+- Fix [crash during styleURL change on adroid](https://github.com/rnmapbox/maps/pull/1119)
+- Fix [warning Sending LogEvent with no listeners registered.](https://github.com/rnmapbox/maps/pull/1108)
+- Fix [race in close map and icon image download](https://github.com/rnmapbox/maps/pull/1089)
+- Fix [android padding](https://github.com/rnmapbox/maps/pull/1087)
+- Android [custom mapboxgl version](https://github.com/rnmapbox/maps/pull/1088)
+- Fix [support 6.\* of MapboxGL IOS by setting `$ReactNativeMapboxGLIOSVersion = "6.2.1"` in Podfile](https://github.com/rnmapbox/maps/pull/1044)
+- Fix [map rendered at (0,0,0,0) on iOS](https://github.com/rnmapbox/maps/pull/1084)
+- Fix [edge Padding + auto limit padding on iOS](https://github.com/rnmapbox/maps/pull/1057)
+- Fix [coordinate 0,0 was considered invalid on IOS](https://github.com/rnmapbox/maps/pull/1076)
+- Fix [refresh on PointAnnotation on Android](https://github.com/rnmapbox/maps/pull/1062)
+- Fix [Image source coordinates update on the fly](https://github.com/rnmapbox/maps/pull/1036/files)
+- Upgrade to [ios 5.9.0](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v5.9.0)
+- Upgrade to [android 9.1.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v9.1.0)
+- Set default Mapbox logging verbosity to warning. (Change it using Logger.setLogLevel('verbose'))
+- Error/Warn mapbox log messages are treated as redbox/yellowbox errors/warnings. (Override it using Logger.setLoggerCallback(log => { return true })
+- Native user location [#825](https://github.com/rnmapbox/maps/pull/825)
+
+## 8.1.0-rc10
+
+- By default [use 5.9.0 Mapbox on iOS as 8.1.0rc8 and before](https://github.com/rnmapbox/maps/pull/1120)
+- Fix [crash during styleURL change on adroid](https://github.com/rnmapbox/maps/pull/1119)
+- Fix [warning Sending LogEvent with no listeners registered.](https://github.com/rnmapbox/maps/pull/1108)
+- Fix [race in close map and icon image download](https://github.com/rnmapbox/maps/pull/1089)
+- Fix [android padding](https://github.com/rnmapbox/maps/pull/1087)
+- Android [custom mapboxgl version](https://github.com/rnmapbox/maps/pull/1088)
+- Fix [support 6.\* of MapboxGL IOS by setting `$ReactNativeMapboxGLIOSVersion = "6.2.1"` in Podfile](https://github.com/rnmapbox/maps/pull/1044)
+- Fix [map rendered at (0,0,0,0) on iOS](https://github.com/rnmapbox/maps/pull/1084)
+- Fix [edge Padding + auto limit padding on iOS](https://github.com/rnmapbox/maps/pull/1057)
+- Fix [coordinate 0,0 was considered invalid on IOS](https://github.com/rnmapbox/maps/pull/1076)
+- Fix [refresh on PointAnnotation on Android](https://github.com/rnmapbox/maps/pull/1062)
+- Fix [Image source coordinates update on the fly](https://github.com/rnmapbox/maps/pull/1036/files)
+- Upgrade to [ios 5.9.0](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v5.9.0)
+- Upgrade to [android 9.1.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v9.1.0)
+- Set default Mapbox logging verbosity to warning. (Change it using Logger.setLogLevel('verbose'))
+- Error/Warn mapbox log messages are treated as redbox/yellowbox errors/warnings. (Override it using Logger.setLoggerCallback(log => { return true })
+- Native user location [#825](https://github.com/rnmapbox/maps/pull/825)
+
+## 8.1.0.rc10
+
+- By default [use 5.9.0 Mapbox on iOS as 8.1.0rc8 and before](https://github.com/rnmapbox/maps/pull/1120)
+- Fix [crash during styleURL change on adroid](https://github.com/rnmapbox/maps/pull/1119)
+- Fix [warning Sending LogEvent with no listeners registered.](https://github.com/rnmapbox/maps/pull/1108)
+
+## 8.1.0.rc9
+
+- Fix [race in close map and icon image download](https://github.com/rnmapbox/maps/pull/1089)
+
+## 8.1.0.rc8
+
+- Fix [android padding](https://github.com/rnmapbox/maps/pull/1087)
+- Android [custome mapboxgl version](https://github.com/rnmapbox/maps/pull/1088)
+
+## 8.1.0.rc7
+
+- Fix [map rendered at (0,0,0,0) on iOS](https://github.com/rnmapbox/maps/pull/1084)
+
+## 8.1.0.rc6
+
+- Fix [edge Padding + auto limit padding on iOS](https://github.com/rnmapbox/maps/pull/1057)
+- Fix [coordinate 0,0 was considered invalid on IOS](https://github.com/rnmapbox/maps/pull/1076)
+- Fix [refresh on PointAnnotation on Android](https://github.com/rnmapbox/maps/pull/1062)
+
+## 8.1.0.rc5
+
+- Fix [support 6.\* of MapboxGL IOS by setting `$ReactNativeMapboxGLIOSVersion = "6.2.1"` in Podfile](https://github.com/rnmapbox/maps/pull/1044)
+- Fix [Image source coordinates update on the fly](https://github.com/rnmapbox/maps/pull/1036/files)
+
+## 8.1.0.rc4
+
+## 8.1.0.rc3
+
+- Fix [android crashes](https://github.com/rnmapbox/maps/pull/963)
+- Fix [android padding addition](https://github.com/rnmapbox/maps/pull/973)
+- Fix [iOS interface for getAccessToken() on Android](https://github.com/rnmapbox/maps/pull/954)
+
+## 8.1.0.rc2
+
+- Fix [camera padding on android](https://github.com/rnmapbox/maps/pull/941)
+- Allow [zPosition on iOS](https://github.com/rnmapbox/maps/pull/942) in PointAnnotation child views.
+- Added [InvalidatePack](https://github.com/rnmapbox/maps/pull/929)
+- Allow to [customize iOS framework version used](https://github.com/rnmapbox/maps/pull/940)
+
+## 8.1.0.rc1
+
+- Added [invalidateAmbientCache](https://github.com/rnmapbox/maps/pull/899)
+- Implemented [ShapeSource#features](https://github.com/rnmapbox/maps/pull/911)
+
+## 8.1.0.beta
+
+- Upgrade to [ios 5.8.0](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v5.8.0)
+- Upgrade to [android 9.1.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v9.1.0)
+- Set default Mapbox logging verbosity to warning. (Change it using Logger.setLogLevel('verbose'))
+- Error/Warn mapbox log messages are treated as redbox/yellowbox errors/warnings. (Override it using Logger.setLoggerCallback(log => { return true })
+- Native user location [#825](https://github.com/rnmapbox/maps/pull/825)
+
+## 8.0.0
+
+### Breaking changes - [#610](https://github.com/rnmapbox/maps/issues/610)
+
+- iOS mapbox libraries updated to [5.7.0](https://github.com/mapbox/mapbox-gl-native-ios/releases/tag/ios-v5.7.0) android libraries updated to [9.0.0](https://github.com/mapbox/mapbox-gl-native-android/releases/tag/android-v9.0.0)
+- ShapeSource#images is now removed (deprecated in 7.\*), use Images#images instead. Also special `assets` inside `images` is now deprecated, use `nativeAssetImages` istead.
+- iOS now defaults to non `use_frameworks!`, if you want to continue to use `use_frameworks!` please see our iOS installation guidelines
+- [Images#onImagesMissing](docs/Images.md)
+- Android code migrated to AndroidX, RN 60.0+ is recommended.
+- geoUtils is now private, please use [turf-js](https://turfjs.org/) instead
+- VectorSource/SymbolSource#onPress sends ({features, point, coordinates}) instead of single feature in `event.nativeEvent.payload`. [PR#700](https://github.com/rnmapbox/maps/pull/700)
+
+### Changes:
+
+- added [MarkerView](docs/MarkerView.md)
+- added AnimatedShape and AnimatedCoordinatesArray [PR#702](https://github.com/rnmapbox/maps/pull/702)
+
+## 7.2.0
+
+- Upstream changes in Mapbox iOS SDK 5.6.0 has made installing the SDK as an embedded framework difficult. We have therefore discontinued supporting manual installations. To update, follow the iOS installation instructions using cocoapods.
+
+## 7.0.0
+
+### Breaking changes:
+
+- iOS mapbox libraries updated to [5.5.0](https://github.com/mapbox/mapbox-gl-native/releases/tag/ios-v5.3.2) android libraries updated to [8.2.1](https://github.com/mapbox/mapbox-gl-native/releases/tag/android-v8.2.1)
+- `StyleSheet.create` removed.
+  Mapbox styles are now just a map no need for `StyleSheet.create`.
+  `StylesSheet.identity` also removed, use expressions array instead:
+
+  ```jsx
+  mapboxStyle=MapboxGL.Stylesheet.create({..., fillColor: MapboxGL.Stylesheet.identity('color') ...})
+  ...
+  <MapView
+    ...
+    <FillLayer style={mapboxStyle}... />
+  </MapView>
+  ```
+
+  is now:
+
+  ```jsx
+  mapboxStyle={..., fillColor: ['get', 'color'] ...}
+  ...
+  <MapView
+    ...
+    <FillLayer style={mapboxStyle}... />
+  </MapView>
+  ```
+
+  See [docs/StyleSheet.md](docs/StyleSheet.md) for more examples
+
+- `isTelemetryEnabled` removed (as no longer supported on android) [#1](https://github.com/mfazekas/maps/pull/1)
+- MapView#flyTo, MapView#bitBounds, MapView#flyTo, MapView#moveTo, MapView#zoomTo, MapView#setCamera moved to Camera. There is also experimantal properties, to replace those. See [docs/Camera.md](docs/Camera.md)
+- Camera related properties on `MapView` now have to be specified on a camera object:
+
+  ```jsx
+  <MapView
+     zoomLevel={8}
+     centerCoordinate={[-111.8678, 40.2866]}
+     ...
+  >
+     ...
+  </MapView>
+  ```
+
+  is now:
+
+  ```jsx
+  <MapView
+    ...
+  >
+    <Camera
+       zoomLevel={8}
+       centerCoordinate={[-111.8678, 40.2866]}
+    />
+  </MapView>
+  ```
+
+  See [docs/Camera.md](docs/Camera.md) for more examples
+
+- User tracking properties moved from `MapView` to `Camera`
+
+  ```jsx
+  <MapView
+     userTrackingMode={UserTrackingModes.Follow}
+     ...
+  >
+     ...
+  </MapView>
+  ```
+
+  is now:
+
+  ```jsx
+  <MapView
+    ...
+  >
+    <Camera
+       followUserLocation=true
+       followUserMode="normal"
+    />
+  </MapView>
+  ```
+
+  The following properties were changed:
+
+  - MapView#userTrackingMode is now Camera#followUserMode and Camera#followUserLocation
+  - followUserMode is now a string with ('normal','compass','course'), and UserTrackingModes enum is deprecated
+  - MapView#onUserTrackingModeChange is now Camera#onUserTrackingModeChange and payload contains followUserMode and followUserLocation.
+
+- ShapeSource#images was depreacted, use Images#images instead.
+
+  ```jsx
+  <MapView
+    ...
+  >
+    ...
+    <Images images={{pin, dot}} />
+    ...
+    <ShapeSource ... >
+       <SymbolLayer ...>
+    </ShapeSource>
+  </MapView>
+  ```
+
+- TODO document all changes

package/CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+## Setup for creating pull requests
+- Fork this project
+- In your fork, create a branch, for example: `fix/camera-update`
+- Add your changes
+- Push and open a PR with your branch
+
+## Testing my changes
+The metro bundler under `/example` is set up to use the libraries files under root.  
+Which means, when you change something within `javascript/components/UserLocation.js`  
+it will be reflected in any scene in example that uses that component.
+
+## Best practices for PR's
+- If you add a feature, make sure you add it to the documentation
+- If you add an objective-c or java method, make sure you update the declaration file: `index.d.ts`.
+- Make sure to use small concise commits
+- Use meaningful commit messages
+- Make sure to update/ add new tests for your changes
+- If you add a new feature make sure to add a scene in `/example` for others to see/ test it
+
+## Documentation
+Documentation is generated from code blocks and comments.  
+It will be auto-generated when you commit changes.  
+If any changes are generated from your edits, the changed files will need to be added using `git add` before attempting the commit again.  
+To manually generate the changes, run `npm run generate`.  
+
+Notice, that changing the documentation in the individual <COMPONENT>.md within `/docs` will not suffice.  
+The correct way is the above described
+ 

package/LICENSE.md

@@ -0,0 +1,5 @@
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README-v10.md

@@ -0,0 +1,86 @@
+# Getting Started
+
+
+```shell
+react-native init sample --version 0.60.5
+cd sample
+yarn add https://github.com/rnmapbox/maps#main --save
+
+code android/build.gradle 
+```
+
+```gradle
+# add the following:
+allprojects {
+    repositories {
+        maven {
+            url 'https://api.mapbox.com/downloads/v2/releases/maven'
+            authentication {
+                basic(BasicAuthentication)
+            }
+            credentials {
+                // Do not change the username below.
+                // This should always be `mapbox` (not your username). 
+                username = 'mapbox'
+                // Use the secret token you stored in gradle.properties as the password
+                password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
+            }
+        }
+    }
+}
+```
+
+code android/app/build.gradle
+```gradle
+# add the following:
+android {
+    packagingOptions {
+        pickFirst 'lib/x86/libc++_shared.so'
+        pickFirst 'lib/x86_64/libc++_shared.so'
+        pickFirst 'lib/arm64-v8a/libc++_shared.so'
+        pickFirst 'lib/armeabi-v7a/libc++_shared.so'
+    }
+}
+```
+
+code android/build.gradle
+```
+buildscript {
+    ext {
+      ...
+      RNMapboxMapsImpl = 'mapbox'
+    }
+}
+```
+
+code ios/Podfile
+```pod
+  # change these
+  $RNMapboxMapsImpl = 'mapbox'
+
+  platform :ios, '13.0'
+
+  ...
+
+  ...
+
+  pre_install do |installer|
+    $RNMapboxMaps.pre_install(installer)
+  end
+  
+  post_install do |installer|
+    react_native_post_install(installer)
+    $RNMapboxMaps.post_install(installer)
+  end
+```
+
+```pod
+# on RN 0.60 only:
+# add modular_headers to `React-Core`
+pod 'React-Core', :path => '../node_modules/react-native/React', modular_headers: true
+```
+
+IOS:
+
+ * Add `$(SDKROOT)/usr/lib/swift` to Library search paths.
+