README.md in google-cloud-dialogflow-0.15.0 vs README.md in google-cloud-dialogflow-1.0.0

- old
+ new

@@ -1,43 +1,53 @@ -# Ruby Client for Dialogflow API +# Ruby Client for the Dialogflow API -[Dialogflow API][Product Documentation]: -Builds conversational interfaces (for example, chatbots, and voice-powered -apps and devices). -- [Client Library Documentation][] -- [Product Documentation][] +API Client library for the Dialogflow API -## Quick Start -In order to use this library, you first need to go through the following -steps: +Dialogflow is an end-to-end, build-once deploy-everywhere development suite for creating conversational interfaces for websites, mobile applications, popular messaging platforms, and IoT devices. You can use it to build interfaces (such as chatbots and conversational IVR) that enable natural and rich interactions between your users and your business. -1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) -2. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) -3. [Enable the Dialogflow API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com) -4. [Setup Authentication.](https://googleapis.dev/ruby/google-cloud-dialogflow/latest/file.AUTHENTICATION.html) +Actual client classes for the various versions of this API are defined in +_versioned_ client gems, with names of the form `google-cloud-dialogflow-v*`. +The gem `google-cloud-dialogflow` is a convenience wrapper library that brings the +verisoned gems in as dependencies, and provides high-level methods for +constructing clients. -### Installation +View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-dialogflow/latest) +for this library, google-cloud-dialogflow, to see the convenience methods for +constructing client objects. Reference documentation for the client objects +themselves can be found in the client library documentation for the versioned +client gems: +[google-cloud-dialogflow-v2](https://googleapis.dev/ruby/google-cloud-dialogflow-v2/latest). + +See also the [Product Documentation](https://cloud.google.com/dialogflow) +for more usage information. + +## Quick Start + ``` $ gem install google-cloud-dialogflow ``` -### Next Steps -- Read the [Client Library Documentation][] for Dialogflow API - to see other available methods on the client. -- Read the [Dialogflow API Product documentation][Product Documentation] - to learn more about the product and see How-to Guides. -- View this [repository's main README](https://github.com/googleapis/google-cloud-ruby/blob/master/README.md) - to see the full list of Cloud APIs that we cover. +In order to use this library, you first need to go through the following steps: -[Client Library Documentation]: https://googleapis.dev/ruby/google-cloud-dialogflow/latest -[Product Documentation]: https://cloud.google.com/dialogflow +1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) +1. [Enable billing for your project.](https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project) +1. [Enable the API.](https://console.cloud.google.com/apis/library/dialogflow.googleapis.com) +1. {file:AUTHENTICATION.md Set up authentication.} +## Migrating from 0.x versions + +The 1.0 release of the google-cloud-dialogflow client is a significant upgrade +based on a [next-gen code generator](https://github.com/googleapis/gapic-generator-ruby), +and includes substantial interface changes. Existing code written for earlier +versions of this library will likely require updates to use this version. +See the {file:MIGRATING.md MIGRATING.md} document for more information. + ## Enabling Logging To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. -The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, +The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googleapis.dev/ruby/google-cloud-logging/latest) -that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) +that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information. Configuring a Ruby stdlib logger: ```ruby