Skip to content

Commit

Permalink
Add KujakuLibrary setup instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
ekigamba committed Nov 1, 2022
1 parent 0658890 commit 0879113
Showing 1 changed file with 29 additions and 12 deletions.
41 changes: 29 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,25 +25,23 @@ A mapping and check-in library for Android using **MapBox SDK (Version 8.3.3)**

For instructions on how to run the sample app see [these instructions](./sample/README.md).

### Importing the Library

### How to publish artifacts

You can easily publish a snapshot artefact by creating a tag for the library or util module. Follow the steps below:

#### To publish the utils module
1. Update the `utils` version in this file `utils\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
2. Create a PR with the change and have it merged
3. Generate a tag with the title `utils-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages
1. Update the `utils` version in this file `utils\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
2. Create a PR with the change and have it merged
3. Generate a tag with the title `utils-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages

#### To publish the library module

1. Follow the steps above to get the latest version of `utils` as a dependency in your library snapshot
2. Update the `library` version in this file `library\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
2. Create a PR with the change and have it merged
3. Generate a tag with the title `library-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages
1. Follow the steps above to get the latest version of `utils` as a dependency in your library snapshot
2. Update the `library` version in this file `library\build.gradle` in the format `X.Y.Z-SNAPSHOT` where X, Y and Z should be replaced with the version numbers of the major vesion, minor version and build versions respectively.
3. Create a PR with the change and have it merged
4. Generate a tag with the title `library-vX.Y.X-SNAPSHOT` and push it. This will trigger a publish of the artefact snapshot version to Sonatype and Github packages

- Due to the sunsetting of JFrog Bintray, Kujaku artefacts/release are no longer available on bintray and all publishing is done to Maven Central. Some of the packages are also published to Github packages.
Due to the sunsetting of JFrog Bintray, Kujaku artefacts/release are no longer available on bintray and all publishing is done to Maven Central. Some of the packages are also published to Github packages.

## How to import the library

Expand Down Expand Up @@ -80,18 +78,37 @@ dependencies {
}
```

3. Initialise the library

This can be done in the Application class

```
KujakuLibrary.init(this);
```

4. Set the Mapbox key

This is required before any use of the library such as offline map downloads or viewing a map

```
Mapbox.getInstance(context, "ACCESS-TOKEN");
```

## How to use the library

The library offers a view `KujakuMapView` that provides more functionality than Mapbox.
- For Mapbox related functionality, [go here](https://docs.mapbox.com/android/maps/overview/)
- For setup information and extra features provided by this library [go here](./SPECIFICATION.md)
* For Mapbox related functionality, [go here](https://docs.mapbox.com/android/maps/overview/)
* For setup information and extra features provided by this library [go here](./SPECIFICATION.md)



## `Unable to resolve artifact: Missing` while running tests

This is encountered when Robolectric has problems downloading the jars it needs for different Android SDK levels. If you keep running into this you can download the JARs locally and point Robolectric to them by doing:

```
./download-robolectric-deps.sh
```

## License

Expand Down

0 comments on commit 0879113

Please sign in to comment.