Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: update install instructions #3

Merged
merged 1 commit into from
Dec 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,21 +24,21 @@ See [Configure Credential](https://docs.mapbox.com/ios/navigation/guides/get-sta
]}>
<TabItem value="npm">

```shell
```bash
npm install @rnmapbox/maps
```

</TabItem>
<TabItem value="yarn">

```shell
```bash
yarn add @rnmapbox/maps
```

</TabItem>
<TabItem value="expo">

```shell
```bash
expo install @rnmapbox/maps
```

Expand All @@ -59,26 +59,29 @@ expo install @rnmapbox/maps
Add the following to your `ios/Podfile`

```ruby
// highlight-start
pre_install do |installer|
$RNMapboxMaps.pre_install(installer)
# ... other pre install hooks
end
// highlight-end

post_install do |installer|
// highlight-start
$RNMapboxMaps.post_install(installer)
// highlight-end
# ... other post install hooks
end
```

### Verify .netrc
Make sure your `.netrc` is configured with your secret access token, as described by the [mapbox docs](https://docs.mapbox.com/ios/maps/guides/install/#configure-credentials). To verify execute:

```sh
```bash
grep -A 4 api.mapbox.com ~/.netrc
```

This should output something like:
```sh
```bash
machine api.mapbox.com
login mapbox
password sk.ey...
Expand All @@ -97,6 +100,7 @@ Add the following to your android/build.gradle, into the section `allprojects/re
allprojects {
repositories {
// ...other repos
// highlight-start
maven {
url 'https://api.mapbox.com/downloads/v2/releases/maven'
authentication {
Expand All @@ -110,6 +114,7 @@ allprojects {
password = project.properties['MAPBOX_DOWNLOADS_TOKEN'] ?: ""
}
}
// highlight-end
// ...even more repos?
}
}
Expand All @@ -119,12 +124,12 @@ allprojects {

Make sure your global `.gradle-properties` is configured with your secret access token, as described by the [mapbox docs](https://docs.mapbox.com/android/maps/guides/install/#configure-credentials). To verify execute:

```sh
```bash
grep -R MAPBOX_DOWNLOADS_TOKEN ~/.gradle/gradle.properties
```

This should output something like:
```sh
```bash
/Users/foo/.gradle/gradle.properties:MAPBOX_DOWNLOADS_TOKEN=sk.ey...
```

Expand All @@ -143,10 +148,12 @@ Add `RNMapboxMapsDownloadToken` to the @rnmapbox/maps [config plugin](https://do
"expo": {
"plugins": [
[
// highlight-start
"@rnmapbox/maps",
{
"RNMapboxMapsDownloadToken": "sk.ey.."
}
// highlight-end
]
]
}
Expand Down Expand Up @@ -181,7 +188,9 @@ Set `RNMapboxMapsVersion` in `android/build.gradle` > `buildscript` > `ext` sect
```gradle
buildscript {
ext {
// highlight-start
RNMapboxMapsVersion = '11.0.0'
// highlight-end
}
}
```
Expand All @@ -199,7 +208,9 @@ Add `RNMapboxMapsVersion` to the @rnmapbox/maps [config plugin](https://docs.exp
"@rnmapbox/maps",
{
...
// highlight-start
"RNMapboxMapsVersion": "11.0.0"
// highlight-end
}
]
]
Expand Down
1 change: 1 addition & 0 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,6 +136,7 @@ const config = {
prism: {
theme: lightTheme,
darkTheme: darkTheme,
additionalLanguages: ['ruby', 'gradle', 'bash', 'json'],
},
algolia: {
appId: 'DSWU223Y1Q',
Expand Down