Skip to content

Commit c475f1b

Browse files
jmdobryjmdobry
committed
Finished a bunch more Readme files.
1 parent 7e1f7b0 commit c475f1b

File tree

16 files changed

+333
-181
lines changed

16 files changed

+333
-181
lines changed

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ recognition technologies into developer applications.
303303
View the [Cloud Speech API Node.js samples][speech_samples].
304304

305305
[speech_signup]: https://services.google.com/fb/forms/speech-api-alpha/
306-
[speech_docs]: https://cloud.google.com/speech/docs/
306+
[speech_docs]: https://cloud.google.com/speech/
307307
[speech_samples]: speech
308308

309309
### Google Cloud Storage

‎appengine/README.md‎

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ create a project/app id. (App id and project id are identical.)
5252

5353

5454
## Samples
55+
5556
__Google (Cloud) Products__
5657

5758
- Google Analytics - [Source code][aeanalytics_1]
@@ -98,96 +99,96 @@ __Other Examples__
9899
- Reading/writing from/to disk - [Source code][aedisk_1]
99100
- Serving static files - [Source code][aestaticfiles_1]
100101

101-
[aeanalytics_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/analytics
102-
[aelogging_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/logging
103-
[aepubsub_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/pubsub
104-
[aestorage_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/storage
102+
[aeanalytics_1]: analytics
103+
[aelogging_1]: logging
104+
[aepubsub_1]: pubsub
105+
[aestorage_1]: storage
105106

106-
[express_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/express
107+
[express_1]: express
107108
[express_2]: https://cloud.google.com/nodejs/resources/frameworks/express
108109
[express_3]: http://express-dot-nodejs-docs-samples.appspot.com
109110
[express_4]: http://expressjs.com/
110-
[express_5]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/express-memcached-session
111+
[express_5]: express-memcached-session
111112
[express_6]: https://github.com/balor/connect-memcached
112113

113-
[geddy_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/geddy
114+
[geddy_1]: geddy
114115
[geddy_2]: https://cloud.google.com/nodejs/resources/frameworks/geddy
115116
[geddy_3]: http://geddy-dot-nodejs-docs-samples.appspot.com
116117
[geddy_4]: http://geddyjs.org/
117118

118-
[hapi_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/hapi
119+
[hapi_1]: hapi
119120
[hapi_2]: https://cloud.google.com/nodejs/resources/frameworks/hapi
120121
[hapi_3]: http://hapi-dot-nodejs-docs-samples.appspot.com
121122
[hapi_4]: http://hapijs.com/
122123

123-
[loopback_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/loopback
124+
[loopback_1]: loopback
124125
[loopback_2]: https://cloud.google.com/nodejs/resources/frameworks/loopback
125126
[loopback_3]: http://loopback-dot-nodejs-docs-samples.appspot.com
126127
[loopback_4]: http://loopback.io/
127128

128-
[koa_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/koa
129+
[koa_1]: koa
129130
[koa_2]: https://cloud.google.com/nodejs/resources/frameworks/koa
130131
[koa_3]: http://koa-dot-nodejs-docs-samples.appspot.com
131132
[koa_4]: http://koajs.com/
132133

133-
[kraken_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/kraken
134+
[kraken_1]: kraken
134135
[kraken_2]: https://cloud.google.com/nodejs/resources/frameworks/kraken
135136
[kraken_3]: http://kraken-dot-nodejs-docs-samples.appspot.com
136137
[kraken_4]: http://krakenjs.com/
137138

138-
[parse_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/parse-server
139+
[parse_1]: parse-server
139140

140-
[restify_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/restify
141+
[restify_1]: restify
141142
[restify_2]: https://cloud.google.com/nodejs/resources/frameworks/restify
142143
[restify_3]: http://restify-dot-nodejs-docs-samples.appspot.com
143144
[restify_4]: http://restify.com/
144145

145-
[sails_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/sails
146+
[sails_1]: sails
146147
[sails_2]: https://cloud.google.com/nodejs/resources/frameworks/sails
147148
[sails_3]: http://sails-dot-nodejs-docs-samples.appspot.com
148149
[sails_4]: http://sailsjs.org/
149150

150-
[aedatastore_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/datastore
151-
[aecloudsql_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/cloudsql
152-
[memcached_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/memcached
151+
[aedatastore_1]: datastore
152+
[aecloudsql_1]: cloudsql
153+
[memcached_1]: memcached
153154

154-
[mongodb_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/mongodb
155+
[mongodb_1]: mongodb
155156
[mongodb_2]: https://cloud.google.com/nodejs/resources/databases/mongodb
156157
[mongodb_3]: https://docs.mongodb.org/
157158

158-
[redis_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/redis
159+
[redis_1]: redis
159160
[redis_2]: https://cloud.google.com/nodejs/resources/databases/redis
160161
[redis_3]: https://redis.io/
161162

162163
[gcloud_1]: https://github.com/GoogleCloudPlatform/gcloud-node
163164
[gcloud_2]: https://googlecloudplatform.github.io/gcloud-node/#/
164165

165-
[bower_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/bower
166+
[bower_1]: bower
166167
[bower_2]: https://cloud.google.com/nodejs/resources/tools/bower
167168
[bower_3]: http://bower.io/
168169

169-
[grunt_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/grunt
170+
[grunt_1]: grunt
170171
[grunt_2]: https://cloud.google.com/nodejs/resources/tools/grunt
171172
[grunt_3]: http://grunt-dot-nodejs-docs-samples.appspot.com
172173
[grunt_4]: http://gruntjs.com/
173174

174-
[mailgun_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/mailgun
175+
[mailgun_1]: mailgun
175176
[mailgun_2]: https://cloud.google.com/nodejs/resources/tools/mailgun
176177
[mailgun_3]: http://www.mailgun.com/
177178

178-
[sendgrid_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/sendgrid
179+
[sendgrid_1]: sendgrid
179180
[sendgrid_2]: https://cloud.google.com/nodejs/resources/tools/sendgrid
180181
[sendgrid_3]: http://sendgrid.com/
181182

182-
[twilio_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/twilio
183+
[twilio_1]: twilio
183184

184-
[webpack_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/webpack
185+
[webpack_1]: webpack
185186
[webpack_2]: https://cloud.google.com/nodejs/resources/tools/webpack
186187
[webpack_3]: https://webpack.github.io/
187188

188-
[websockets_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/websockets
189+
[websockets_1]: websockets
189190

190-
[expresshw_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/hello-world
191-
[aedisk_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/disk
192-
[aeextending_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/extending-runtime
193-
[aestaticfiles_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/appengine/static-files
191+
[expresshw_1]: hello-world
192+
[aedisk_1]: disk
193+
[aeextending_1]: extending-runtime
194+
[aestaticfiles_1]: static-files

‎computeengine/README.md‎

Lines changed: 75 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,93 @@
1-
## Compute Engine Samples
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
22

3-
These samples require two environment variables to be set:
3+
# Google Compute Engine Node.js Samples
44

5-
- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can
6-
download one from your Google project's "permissions" page.
7-
- `GCLOUD_PROJECT` - Id of your Google project.
5+
[Compute Engine][compute_docs] lets you create and run virtual machines on
6+
Google infrastructure.
87

9-
## Run the samples
8+
[compute_docs]: https://cloud.google.com/compute/docs/
109

11-
Install dependencies:
10+
## Table of Contents
1211

13-
npm install
12+
* [Setup](#setup)
13+
* [Samples](#samples)
14+
* [Sending mail with Sendgrid](#sending-mail-with-sendgrid)
15+
* [Sending mail with Mailjet](#sending-mail-with-mailjet)
16+
* [Listing instances (recommended)](#listing-instances-recommended)
17+
* [Listing instances](#listing-instances)
1418

15-
### sendgrid.js
19+
## Setup
1620

17-
Requires a `SENDGRID_API_KEY` environment variable to be set.
21+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
22+
1. Install dependencies:
1823

19-
npm run sendgrid
24+
npm install
2025

21-
### mailjet.js
26+
[prereq]: ../README.md#prerequisities
27+
[run]: ../README.md#how-to-run-a-sample
2228

23-
Requires `MAILJET_API_KEY` and `MAILJET_API_SECRET` environment variables to be
24-
set.
29+
## Samples
2530

26-
npm run mailjet
31+
### Sending mail with Sendgrid
2732

28-
### vms.js
33+
View the [documentation][sendgrid_1] or the [source code][sendgrid_2].
2934

30-
npm run vms
35+
__Run the sample:__
3136

32-
### vms_api.js
37+
1. Set the `SENDGRID_API_KEY` environment variable:
3338

34-
npm run vms_api
39+
export SENDGRID_API_KEY=<your-sendgrid-api-key>
3540

36-
- Sendgrid sample - [Source code][compute_sendgrid_1] | [Documentation][compute_sendgrid_2]
37-
- VMs sample - [Source code][compute_vms_1] | [Documentation][compute_vms_2]
41+
1. Start the server:
3842

39-
[compute_sendgrid_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/computeengine/sendgrid.js
40-
[compute_sendgrid_2]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-sendgrid
43+
node sendgrid
4144

42-
[compute_vms_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/computeengine/vms.js
43-
[compute_vms_2]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide
45+
1. Open http://localhost:8080 in your browser
46+
47+
[sendgrid_1]: sendgrid.js
48+
[sendgrid_2]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-sendgrid
49+
50+
### Sending mail with Mailjet
51+
52+
View the [documentation][mailjet_1] or the [source code][mailjet_2].
53+
54+
__Run the sample:__
55+
56+
1. Set the `MAILJET_API_KEY` environment variable:
57+
58+
export MAILJET_API_KEY=<your-mailjet-api-key>
59+
60+
1. Set the `MAILJET_API_SECRET` environment variable:
61+
62+
export MAILJET_API_SECRET=<your-mailjet-api-secret>
63+
64+
1. Start the server:
65+
66+
node mailjet
67+
68+
1. Open http://localhost:8080 in your browser
69+
70+
[mailjet_1]: mailjet.js
71+
[mailjet_2]: https://cloud.google.com/compute/docs/tutorials/sending-mail/using-mailjet
72+
73+
### Listing instances (recommended)
74+
75+
View the [documentation][vms_1] or the [source code][vms_2].
76+
77+
__Run the sample:__
78+
79+
node vms
80+
81+
[vms_1]: vms.js
82+
[vms_2]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide
83+
84+
### Listing instances
85+
86+
View the [documentation][vms_api_1] or the [source code][vms_api_2].
87+
88+
__Run the sample:__
89+
90+
node vms_api
91+
92+
[vms_api_1]: vms_api.js
93+
[vms_api_2]: https://cloud.google.com/compute/docs/tutorials/nodejs-guide

‎computeengine/package.json‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,6 @@
88
"engines": {
99
"node": ">=0.10.x"
1010
},
11-
"scripts": {
12-
"sendgrid": "node sendgrid.js",
13-
"mailjet": "node mailjet.js",
14-
"vms": "node vms.js",
15-
"vms_api": "node vms_api.js"
16-
},
1711
"dependencies": {
1812
"gcloud": "^0.34.0",
1913
"googleapis": "^7.1.0",

‎containerengine/README.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
2+
3+
# Google Container Engine Node.js Samples
4+
5+
[Container Engine][container_docs]: Run Docker containers on Google Cloud
6+
Platform, powered by Kubernetes.
7+
8+
[container_docs]: https://cloud.google.com/container-engine/docs/
9+
10+
## Setup
11+
12+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
13+
1. Install dependencies:
14+
15+
npm install
16+
17+
[prereq]: ../README.md#prerequisities
18+
[run]: ../README.md#how-to-run-a-sample
19+
20+
## Samples
21+
22+
* [Hello World](hello-world/)

‎containerengine/hello-world/README.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
2+
3+
# Google Container Engine World sample
4+
5+
This is a basic hello world sample.
6+
7+
View the [documentation][docs] or the [source code][source].
8+
9+
[docs]: server.js
10+
[source]: https://cloud.google.com/container-engine/docs/quickstart
11+
12+
__Run the sample:__
13+
14+
node server

‎logging/package.json‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,6 @@
88
"engines": {
99
"node": ">=0.10.x"
1010
},
11-
"scripts": {
12-
"list": "node list.js",
13-
"write": "node write.js",
14-
"export": "node export.js"
15-
},
1611
"dependencies": {
1712
"async": "^1.5.2",
1813
"express": "^4.13.4",

‎prediction/README.md‎

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,41 @@
1-
## Prediction API Samples
1+
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
22

3-
These samples require an environment variable to be set:
3+
# Google Cloud Prediction API Node.js Samples
44

5-
- `GOOGLE_APPLICATION_CREDENTIALS` - Path to a service account file. You can
6-
download one from your Google project's "permissions" page.
5+
The [Cloud Prediction API][prediction_docs] provides a RESTful API to build
6+
Machine Learning models.
77

8-
## Run a sample
8+
[prediction_docs]: https://cloud.google.com/prediction/docs/
99

10-
Install dependencies:
10+
## Table of Contents
1111

12-
npm install
12+
* [Setup](#setup)
13+
* [Samples](#samples)
14+
* [Hosted Models](#hosted-models)
1315

14-
To print available commands:
16+
## Setup
1517

16-
npm run
18+
1. Read [Prerequisites][prereq] and [How to run a sample][run] first.
19+
1. Install dependencies:
1720

18-
Execute a sample:
21+
npm install
1922

20-
npm run <sample>
23+
[prereq]: ../README.md#prerequisities
24+
[run]: ../README.md#how-to-run-a-sample
2125

22-
Example:
26+
## Samples
27+
28+
### Hosted Models
29+
30+
View the [documentation][hostedmodels_1] or the [source code][hostedmodels_2].
2331

24-
npm run hostedmodels -- "good evening"
32+
__Run the sample:__
33+
34+
Usage: `node hostedmodels "some phrase"`
35+
36+
Example:
2537

26-
- Hosted Models sample - [Source code][predictionapi_1] | [Documentation][predictionapi_2]
38+
node hostedmodels "Hello world"
2739

28-
[predictionapi_1]: https://github.com/GoogleCloudPlatform/nodejs-docs-samples/blob/master/prediction/hostedmodels.js
29-
[predictionapi_2]: https://cloud.google.com/prediction/docs/developer-guide#predictionfromappengine
40+
[hostedmodels_1]: hostedmodels.js
41+
[hostedmodels_2]: https://cloud.google.com/prediction/docs/developer-guide#predictionfromappengine

‎prediction/package.json‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
"engines": {
99
"node": ">=0.10.x"
1010
},
11-
"scripts": {
12-
"hostedmodels": "node hostedmodels.js"
13-
},
1411
"dependencies": {
1512
"googleapis": "^7.1.0"
1613
}

0 commit comments

Comments
 (0)