Skip to content

Commit 1afeb42

Browse files
chore: regenerate README (#925)
1 parent bc73916 commit 1afeb42

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

.github/readme/synth.metadata/synth.metadata

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44
"git": {
55
"name": ".",
66
"remote": "https://github.com/googleapis/java-bigtable.git",
7-
"sha": "887d6c6661e27643e5f386a7aa6041bb97084c0d"
7+
"sha": "bc73916675c720a8ade9192594f914508bff0eda"
88
}
99
},
1010
{
1111
"git": {
1212
"name": "synthtool",
1313
"remote": "https://github.com/googleapis/synthtool.git",
14-
"sha": "dd05f9d12f134871c9e45282349c9856fbebecdd"
14+
"sha": "3d32990b6f4b57be77455e3ca89e6e21cd0c06b3"
1515
}
1616
}
1717
]

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,11 @@ Java idiomatic client for [Cloud Bigtable][product-docs].
88
- [Product Documentation][product-docs]
99
- [Client Library Documentation][javadocs]
1010

11+
1112
## Quickstart
1213

1314
If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
15+
1416
```xml
1517
<dependencyManagement>
1618
<dependencies>
@@ -34,6 +36,7 @@ If you are using Maven with [BOM][libraries-bom], add this to your pom.xml file
3436

3537
If you are using Maven without BOM, add this to your dependencies:
3638

39+
3740
```xml
3841
<dependency>
3942
<groupId>com.google.cloud</groupId>
@@ -44,17 +47,20 @@ If you are using Maven without BOM, add this to your dependencies:
4447
```
4548

4649
If you are using Gradle 5.x or later, add this to your dependencies
50+
4751
```Groovy
4852
implementation platform('com.google.cloud:libraries-bom:20.9.0')
4953
5054
compile 'com.google.cloud:google-cloud-bigtable'
5155
```
5256
If you are using Gradle without BOM, add this to your dependencies
57+
5358
```Groovy
5459
compile 'com.google.cloud:google-cloud-bigtable:1.27.3'
5560
```
5661

5762
If you are using SBT, add this to your dependencies
63+
5864
```Scala
5965
libraryDependencies += "com.google.cloud" % "google-cloud-bigtable" % "1.27.3"
6066
```
@@ -63,6 +69,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-bigtable" % "1.27.3"
6369

6470
See the [Authentication][authentication] section in the base directory's README.
6571

72+
## Authorization
73+
74+
The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Cloud Bigtable APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Cloud Bigtable API calls.
75+
6676
## Getting Started
6777

6878
### Prerequisites
@@ -530,6 +540,7 @@ and on [google-cloud-java][g-c-j].
530540
This library follows [Semantic Versioning](http://semver.org/).
531541

532542

543+
533544
## Contributing
534545

535546

@@ -541,6 +552,7 @@ Please note that this project is released with a Contributor Code of Conduct. By
541552
this project you agree to abide by its terms. See [Code of Conduct][code-of-conduct] for more
542553
information.
543554

555+
544556
## License
545557

546558
Apache 2.0 - See [LICENSE][license] for more information.
@@ -573,6 +585,9 @@ Java is a registered trademark of Oracle and/or its affiliates.
573585
[maven-version-image]: https://img.shields.io/maven-central/v/com.google.cloud/google-cloud-bigtable.svg
574586
[maven-version-link]: https://search.maven.org/search?q=g:com.google.cloud%20AND%20a:google-cloud-bigtable&core=gav
575587
[authentication]: https://github.com/googleapis/google-cloud-java#authentication
588+
[auth-scopes]: https://developers.google.com/identity/protocols/oauth2/scopes
589+
[predefined-iam-roles]: https://cloud.google.com/iam/docs/understanding-roles#predefined_roles
590+
[iam-policy]: https://cloud.google.com/iam/docs/overview#cloud-iam-policy
576591
[developer-console]: https://console.developers.google.com/
577592
[create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
578593
[cloud-sdk]: https://cloud.google.com/sdk/

0 commit comments

Comments
 (0)