Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

chore: regenerate README #282

Merged
merged 2 commits into from
Aug 11, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
2 changes: 1 addition & 1 deletion .github/readme/synth.metadata/synth.metadata
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"git": {
"name": ".",
"remote": "https://github.com/googleapis/java-dialogflow-cx.git",
"sha": "40571343d51c2275a556a2a45508c014f2e9aee1"
"sha": "6b2152a0fff0dc1ddee98688b511d55679eba728"
}
},
{
Expand Down
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,13 @@ Java idiomatic client for [Dialogflow CX][product-docs].
> Note: This client is a work-in-progress, and may occasionally
> make backwards-incompatible changes.


## Quickstart


If you are using Maven, add this to your pom.xml file:


```xml
<dependency>
<groupId>com.google.cloud</groupId>
Expand All @@ -25,11 +27,13 @@ If you are using Maven, add this to your pom.xml file:
```

If you are using Gradle without BOM, add this to your dependencies

```Groovy
compile 'com.google.cloud:google-cloud-dialogflow-cx:0.8.0'
```

If you are using SBT, add this to your dependencies

```Scala
libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8.0"
```
Expand All @@ -38,6 +42,10 @@ libraryDependencies += "com.google.cloud" % "google-cloud-dialogflow-cx" % "0.8.

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

## Authorization

The client application making API calls must be granted [authorization scopes][auth-scopes] required for the desired Dialogflow CX APIs, and the authenticated principal must have the [IAM role(s)][predefined-iam-roles] required to access GCP resources using the Dialogflow CX API calls.

## Getting Started

### Prerequisites
Expand Down Expand Up @@ -67,8 +75,7 @@ use this Dialogflow CX Client Library.

## Samples

Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory. The samples' `README.md`
has instructions for running the samples.
Samples are in the [`samples/`](https://github.com/googleapis/java-dialogflow-cx/tree/master/samples) directory.

| Sample | Source Code | Try it |
| --------------------------- | --------------------------------- | ------ |
Expand Down Expand Up @@ -141,6 +148,7 @@ This library follows [Semantic Versioning](http://semver.org/).
It is currently in major version zero (``0.y.z``), which means that anything may change at any time
and the public API should not be considered stable.


## Contributing


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


## License

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