README.md in google-cloud-vision-v1p3beta1-0.1.2 vs README.md in google-cloud-vision-v1p3beta1-0.1.3

- old
+ new

@@ -1,6 +1,6 @@ -# Cloud Vision V1p3beta1 +# Ruby Client for the Cloud Vision V1p3beta1 API API Client library for the Cloud Vision V1p3beta1 API Cloud Vision API allows developers to easily integrate vision detection features within applications, including image labeling, face and landmark detection, optical character recognition (OCR), and tagging of explicit content. @@ -8,9 +8,56 @@ ## Installation ``` $ gem install google-cloud-vision-v1p3beta1 +``` + +## 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/vision/v1p3beta1" + +client = Google::Cloud::Vision::V1p3beta1::ProductSearch::Client.new +request = my_create_request +response = client.create_product_set request +``` + +View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-vision-v1p3beta1/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+.