README.md in google-cloud-recommender-v1-0.3.1 vs README.md in google-cloud-recommender-v1-0.3.2
- old
+ new
@@ -1,6 +1,6 @@
-# Recommender V1
+# Ruby Client for the Recommender V1 API
API Client library for the Recommender V1 API
Recommender is a service on Google Cloud that provides usage recommendations for Cloud products and services.
@@ -8,9 +8,56 @@
## Installation
```
$ gem install google-cloud-recommender-v1
+```
+
+## Before You Begin
+
+In order to use this library, you first need to go through the following steps:
+
+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. {file:AUTHENTICATION.md Set up authentication.}
+
+## Quick Start
+
+```ruby
+require "google/cloud/recommender/v1"
+
+client = Google::Cloud::Recommender::V1::Recommender::Client.new
+request = my_create_request
+response = client.list_recommendations request
+```
+
+View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-recommender-v1/latest)
+for class and method documentation.
+
+## 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/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 [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
+require "logger"
+
+module MyLogger
+ LOGGER = Logger.new $stderr, level: Logger::WARN
+ def logger
+ LOGGER
+ end
+end
+
+# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
+module GRPC
+ extend MyLogger
+end
```
## Supported Ruby Versions
This library is supported on Ruby 2.4+.