Skip to content

Commit db5cd6f

Browse files
wescpywescpy
authored
chore: update README template (#90)
1 parent cca7d58 commit db5cd6f

1 file changed

Lines changed: 73 additions & 16 deletions

File tree

‎README-template.md‎

Lines changed: 73 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,41 @@
1-
# New README Template
1+
<!--java/js-only badges-->
2+
[![Maven Central](https://img.shields.io/maven-central/v/com.google.maps.android/MVN-REPO)](https://maven-badges.herokuapp.com/maven-central/com.google.maps.android/MVN-REPO)
3+
[![npm](https://img.shields.io/npm/v/@googlemaps/NPM-REPO)](https://npmjs.com/package/@googlemaps/NPM-REPO)
4+
[![PyPI](https://img.shields.io/pypi/v/PYPI-PKG.svg)](https://pypi.python.org/pypi/PYPI-PKG)
5+
<!-- MVN-REPO, NPM-REPO, or PYPI-PKG may or may not be the same as GH repo, e.g, "android-" -->
6+
7+
<!--lifecycle badges-->
8+
![Alpha](https://img.shields.io/badge/release-alpha-orange)
9+
![Beta](https://img.shields.io/badge/stability-beta-yellow)
10+
<!-- add other releases as nec -->
11+
![GitHub Release](https://img.shields.io/github/v/release/googlemaps/.github)
12+
![Release](https://github.com/googlemaps/REPO/workflows/Release/badge.svg)
13+
14+
<!--repo-specific badges-->
15+
![Stable](https://img.shields.io/badge/stability-stable-green)
16+
[![Tests/Build Status](https://github.com/googlemaps/REPO/actions/workflows/test.yml/badge.svg)](https://github.com/googlemaps/REPO/actions/workflows/test.yml)
17+
<!-- ![Tests/Build Status](https://github.com/googlemaps/REPO/workflows/Test/badge.svg) -->
18+
19+
<!--constant badges-->
20+
![GitHub contributors](https://img.shields.io/github/contributors/googlemaps/REPO?color=green)
21+
[![GitHub License](https://img.shields.io/github/license/googlemaps/REPO?color=blue)][license]
22+
[![StackOverflow](https://img.shields.io/stackexchange/stackoverflow/t/google-maps?color=orange&label=google-maps&logo=stackoverflow)](https://stackoverflow.com/questions/tagged/google-maps)
23+
[![Discord](https://img.shields.io/discord/676948200904589322?color=6A7EC2&logo=discord&logoColor=ffffff)][Discord server]
24+
25+
# New README Template (Alpha|Beta|Frozen)
226

327
## Description
428

5-
This is a sample README file with the recommended sections for new libraries in the github.com/googlemaps organization. This is where you would write a single-sentence description of the project.
29+
This is a sample README file with the recommended sections for new libraries in the <https://github.com/googlemaps> organization. This is where you place the description of the project with a hyperlink to the related product's Overview page on developers.google.com.
630

731
## Requirements
832

9-
Pre-requisites listed here
33+
- [Sign up with Google Maps Platform]
34+
- A Google Maps Platform [project] with the **PRODUCT** enabled
35+
- An [API key] associated with the project above
36+
- (optional) Operating system (and any version) requirements
37+
- (optional) Language(s) (and any version) requirements
38+
- (others)
1039

1140
## Installation
1241

@@ -22,7 +51,8 @@ Link to the same app that demonstrates this library, if it exists (often a folde
2251

2352
## Documentation
2453

25-
Link to full documentation for the library.
54+
- See the [reference documentation] for a full list of classes and their methods.
55+
- (optional) For more guidance, see the [documentation].
2656

2757
## Usage
2858

@@ -34,8 +64,6 @@ Description of feature 1.
3464
Feature 1 sample code
3565
```
3666

37-
</details>
38-
3967
<details>
4068
<summary>Feature 2 title</summary>
4169

@@ -51,21 +79,50 @@ Feature 2 sample code
5179

5280
## Contributing
5381

54-
If contributions are accepted, link to the Contributing.md guide.
82+
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].
83+
84+
OR
85+
86+
External contributions are not accepted for this repository. See [contributing guide] for more info.
5587

5688
## Terms of Service
5789

58-
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](https://cloud.google.com/maps-platform/terms).
90+
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].
5991

6092
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.
6193

6294
## Support
6395

64-
This library is offered via an open source [license](). It is not governed by the Google Maps Platform Support [Technical Support Services Guidelines](https://cloud.google.com/maps-platform/terms/tssg), the [SLA](https://cloud.google.com/maps-platform/terms/sla), or the [Deprecation Policy](https://cloud.google.com/maps-platform/terms) (however, any Google Maps Platform services used by the library remain subject to the Google Maps Platform Terms of Service).
65-
66-
This library adheres to [semantic versioning](https://semver.org/) 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.
67-
68-
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](https://developers.google.com/maps/developer-community). If you'd like to contribute, please check the [Contributing guide]().
69-
70-
You can also discuss this library on our [Discord server](https://discord.gg/hYsWbmk).
71-
96+
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.
97+
98+
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.
99+
100+
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].
101+
102+
You can also discuss this library on our [Discord server].
103+
104+
<!--repo-specific anchor links-->
105+
[API key]: https://developers.google.com/maps/documentation/PRODUCT/get-api-key
106+
[maps-sdk]: https://developers.google.com/maps/documentation/PRODUCT
107+
[reference documentation]: https://googlemaps.github.io/REPO
108+
[documentation]: https://developers.google.com/maps/xxx
109+
[jetpack-compose]: https://developer.android.com/jetpack/compose
110+
[android-maps-ktx]: https://github.com/googlemaps/android-maps-ktx
111+
[npm-pkg]: https://npmjs.com/package/@googlemaps/NPM-REPO
112+
113+
<!--constant anchor links-->
114+
[code of conduct]: ?tab=coc-ov-file#readme
115+
[contributing guide]: CONTRIBUTING.md
116+
[Deprecation Policy]: https://cloud.google.com/maps-platform/terms
117+
[developer community channels]: https://developers.google.com/maps/developer-community
118+
[Discord server]: https://discord.gg/hYsWbmk
119+
[file an issue]: https://github.com/googlemaps/REPO/issues/new/choose
120+
[license]: LICENSE
121+
[pull request]: https://github.com/googlemaps/REPO/compare
122+
[project]: https://developers.google.com/maps/documentation/PRODUCT/cloud-setup#enabling-apis
123+
[semantic versioning]: https://semver.org
124+
[Sign up with Google Maps Platform]: https://console.cloud.google.com/google/maps-apis/start
125+
[similar inquiry]: https://github.com/googlemaps/REPO/issues
126+
[SLA]: https://cloud.google.com/maps-platform/terms/sla
127+
[Technical Support Services Guidelines]: https://cloud.google.com/maps-platform/terms/tssg
128+
[Terms of Service]: https://cloud.google.com/maps-platform/terms

0 commit comments

Comments
 (0)