Skip to content

Commit

Permalink
docs: update jsdoc license/samples-README (#834)
Browse files Browse the repository at this point in the history
  • Loading branch information
bcoe committed Dec 26, 2019
1 parent a93c77d commit a4e9252
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 18 deletions.
29 changes: 14 additions & 15 deletions .jsdoc.js
@@ -1,18 +1,17 @@
/*!
* Copyright 2018 Google LLC. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

'use strict';

Expand Down
12 changes: 9 additions & 3 deletions samples/README.md
Expand Up @@ -28,6 +28,12 @@ Applications that use Google's Server SDKs should not be used in end-user e
Before running the samples, make sure you've followed the steps outlined in
[Using the client library](https://github.com/googleapis/nodejs-firestore#using-the-client-library).

`cd samples`

`npm install`

`cd ..`

## Samples


Expand All @@ -41,7 +47,7 @@ View the [source code](https://github.com/googleapis/nodejs-firestore/blob/maste
__Usage:__


`node quickstart.js`
`node samples/quickstart.js`


-----
Expand All @@ -58,7 +64,7 @@ View the [source code](https://github.com/googleapis/nodejs-firestore/blob/maste
__Usage:__


`node solution-counters.js`
`node samples/solution-counters.js`



Expand All @@ -67,4 +73,4 @@ __Usage:__

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[shell_link]: https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/googleapis/nodejs-firestore&page=editor&open_in_editor=samples/README.md
[product-docs]: https://cloud.google.com/firestore
[product-docs]: https://cloud.google.com/firestore

0 comments on commit a4e9252

Please sign in to comment.