You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* update README to template
* fix: update README to template
* fix: more README fixes from template
* fix: more README fixes from template
* chore: more README fixes from template
---------
Co-authored-by: Jeff Bowman <[email protected]>
@@ -11,10 +16,12 @@ This repository contains [Jetpack Compose][jetpack-compose] components for the [
11
16
12
17
## Requirements
13
18
19
+
* Android API level 21+
14
20
* Kotlin-enabled project
15
21
* Jetpack Compose-enabled project (see [releases](https://github.com/googlemaps/android-maps-compose/releases) for the required version of Jetpack Compose)
16
-
* An [API key][api-key]
17
-
* API level 21+
22
+
*[Sign up with Google Maps Platform]
23
+
* A Google Maps Platform [project] with the **Maps SDK for Android** enabled
24
+
- An [API key] associated with the project above ... follow the [API key instructions] if you're new to the process
18
25
19
26
## Installation
20
27
@@ -37,20 +44,18 @@ dependencies {
37
44
38
45
This repository includes a [sample app](app).
39
46
40
-
To run it:
47
+
To run the demo app, ensure you've met the requirements above then:
41
48
42
-
1. Get a [Maps API key][api-key]
43
-
2. Open the `secrets.properties` file in your top-level directory, and then add the following code. Replace YOUR_API_KEY with your API key. Store your key in this file because secrets.properties is excluded from being checked into a version control system.
49
+
1. Open the `secrets.properties` file in your top-level directory, and then add the following code. Replace YOUR_API_KEY with your API key. Store your key in this file because secrets.properties is excluded from being checked into a version control system.
44
50
If the `secrets.properties` file does not exist, create it in the same folder as the `local.default.properties` file.
45
-
46
51
```
47
52
MAPS_API_KEY=YOUR_API_KEY
48
53
```
49
-
3. Build and run
54
+
1. Build and run
50
55
51
56
## Documentation
52
57
53
-
You can learn more about all the extensions provided by this library by reading the [reference documents][Javadoc].
58
+
See the [documentation] for a full list of classes and their methods.
54
59
55
60
## Usage
56
61
@@ -474,24 +479,42 @@ The colors of the text, line, and shadow are also all configurable (e.g., based
474
479
475
480
## Contributing
476
481
477
-
Contributions are welcome and encouraged! See [contributing] for more info.
482
+
Contributions are welcome and encouraged! If you'd like to contribute, send us a [pull request] and refer to our [code of conduct] and [contributing guide].
483
+
484
+
## Terms of Service
485
+
486
+
This library uses Google Maps Platform services. Use of Google Maps Platform services through this library is subject to the Google Maps Platform [Terms of Service].
487
+
488
+
This library is not a Google Maps Platform Core Service. Therefore, the Google Maps Platform Terms of Service (e.g. Technical Support Services, Service Level Agreements, and Deprecation Policy) do not apply to the code in this library.
478
489
479
490
## Support
480
491
481
-
This library is offered via an open source [license](LICENSE). It is not governed by the Google Maps Platform [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss), the [SLA](https://cloud.google.com/maps-platform/terms/sla?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
492
+
This library is offered via an open source [license]. It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines, the SLA, or the [Deprecation Policy]. However, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service.
482
493
483
-
This library adheres to [semantic versioning](https://semver.org/) to indicate when backwards-incompatible changes are introduced.
494
+
This library adheres to [semantic versioning] to indicate when backwards-incompatible changes are introduced. Accordingly, while the library is in version 0.x, backwards-incompatible changes may be introduced at any time.
484
495
485
-
If you find a bug, or have a feature request, please [file an issue] on GitHub.
496
+
If you find a bug, or have a feature request, please [file an issue] on GitHub. If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our [developer community channels]. If you'd like to contribute, please check the [contributing guide].
486
497
487
-
If you would like to get answers to technical questions from other Google Maps Platform developers, ask through one of our[developer community channels](https://developers.google.com/maps/developer-community?utm_source=github&utm_medium=documentation&utm_campaign=&utm_content=android_oss) including the Google Maps Platform[Discord server].
498
+
You can also discuss this library on our [Discord server].
0 commit comments