Readme: Update readme templates to add api summaries.

[landrito]

cc: @omaray

[codecov-io]

Codecov Report

Merging #1299 into master will increase coverage by <.01%.
The diff coverage is 100%.

@@             Coverage Diff              @@
##             master    #1299      +/-   ##
============================================
+ Coverage     86.46%   86.46%   +<.01%     
  Complexity     3827     3827              
============================================
  Files           374      374              
  Lines         15260    15261       +1     
  Branches       1705     1705              
============================================
+ Hits          13195    13196       +1     
  Misses         1609     1609              
  Partials        456      456

Impacted Files	Coverage Δ	Complexity Δ
...odegen/viewmodel/metadata/PackageMetadataView.java	100% <ø> (ø)	3 <0> (ø)	⬇️
...odegen/transformer/PackageMetadataTransformer.java	94.87% <100%> (+0.13%)	7 <0> (ø)	⬇️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd3d83c...be5b809. Read the comment docs.

[landrito]

Example

As of commit: be5b809

Node.js Clients for Stackdriver Monitoring API (Alpha)

Stackdriver Monitoring API: Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.

• Client Library Documentation
• Product Documentation

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project.
2. Enable the Stackdriver Monitoring API.
3. Setup Authentication.

Installation

$ npm install --save @google-cloud/monitoring

Preview

MetricServiceClient

 var monitoringV3 = require('@google-cloud/monitoring').v3({
   // optional auth parameters.
 });

 var client = monitoringV3.metricServiceClient();
 var formattedName = client.projectPath(projectId);
 // Iterate over all elements.
 client.listMonitoredResourceDescriptors({name: formattedName}).then(function(responses) {
     var resources = responses[0];
     for (var i = 0; i < resources.length; ++i) {
         // doThingsWith(resources[i])
     }
 }).catch(function(err) {
     console.error(err);
 });

 // Or obtain the paged response.
 var options = {autoPaginate: false};
 function callback(responses) {
     // The actual resources in a response.
     var resources = responses[0];
     // The next request if the response shows there's more responses.
     var nextRequest = responses[1];
     // The actual response object, if necessary.
     // var rawResponse = responses[2];
     for (var i = 0; i < resources.length; ++i) {
         // doThingsWith(resources[i]);
     }
     if (nextRequest) {
         // Fetch the next page.
         return client.listMonitoredResourceDescriptors(nextRequest, options).then(callback);
     }
 }
 client.listMonitoredResourceDescriptors({name: formattedName}, options)
     .then(callback)
     .catch(function(err) {
         console.error(err);
     });

Next Steps

• Read the Client Library Documentation for Stackdriver Monitoring API to see other available methods on the client.
• Read the Stackdriver Monitoring API Product documentation to learn more about the product and see How-to Guides.
• View this repository's main README to see the full list of Cloud APIs that we cover.

[landrito]

Probably only need one reviewer since its a pretty simple change. Just wanted to tag all three leads so they are aware of the change.

[omaray]

This is great folks! A few notes

• Should be singular: "Node.js Client..." instead of "Node.js Clients..."
• Then the subtitle "Idiomatic Node.js Client for Stackdriver API" seems to add redundancy a bit with the title above and the description underneath. Perhaps we could have the title as-is, remove the subtitle, and then have the first line be:

"Idiomatic Node.js client for Stackdriver Logging API: ". Where would be "let's write logs....".

But this can also depend on whether or not also contains the words "Stackdriver logging API" as the start. Then it would be weird!

Another option.

(1) Remove the subtitle that says "Idiomatic Node.js client for Stackdriver API".
(2) Make the "Stackdriver Logging API" in the title as a link (so the docs on cloud.google.com)
(3) Have the very first sentence of the readme (that is not a title) be the description we have right now (basically what is already there).

[landrito]

So the logic for the plurality of clients is correct. I think it's simply because some of the services outlined the service yaml are not generated. I'll have to think of a solution.

Gotta get going and will be OOO for the next week. I'll do the second option you said and see where that takes us!

[landrito]

Updated PTAL. Feel free to merge if it looks good!

[omaray]

Looks good. Understood for plurality (we have 2 clients). Last comment: I would remove the link from the title since it's in the first part of the description. Feels like too many links to the docs otherwise. But otherwise lgtm.