Skip to content

Commit e1afae8

Browse files
Merge pull request #687 from stephenplusplus/spp--docs-readme-condensation
readme: condense the fluff
2 parents ce560ab + da73765 commit e1afae8

File tree

1 file changed

+26
-23
lines changed

1 file changed

+26
-23
lines changed

README.md

Lines changed: 26 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,13 @@ var gcloud = require('gcloud')({
7777

7878
You can also set auth on a per-API-instance basis. The examples below show you how.
7979

80+
8081
## Google BigQuery
8182

82-
Analyze Big Data in the cloud with [Google BigQuery][cloud-bigquery] ([docs][cloud-bigquery-docs]) . Run fast, SQL-like queries against multi-terabyte datasets in seconds. Scalable and easy to use, BigQuery gives you real-time insights about your data.
83+
- [API Documentation][gcloud-bigquery-docs]
84+
- [Official Documentation][cloud-bigquery-docs]
8385

84-
See the [gcloud-node BigQuery API documentation][gcloud-bigquery-docs] to learn how to access your BigQuery datasets using this library.
86+
#### Preview
8587

8688
```js
8789
var gcloud = require('gcloud');
@@ -109,13 +111,15 @@ job.getQueryResults(function(err, rows, nextQuery) {});
109111
job.getQueryResults().on('data', function(row) {});
110112
```
111113

114+
112115
## Google Cloud Datastore
113116

114-
[Google Cloud Datastore][cloud-datastore] ([docs][cloud-datastore-docs]) is a fully managed, schemaless database for storing non-relational data. Cloud Datastore automatically scales with your users and supports ACID transactions, high availability of reads and writes, strong consistency for reads and ancestor queries, and eventual consistency for all other queries.
117+
- [API Documentation][gcloud-datastore-docs]
118+
- [Official Documentation][cloud-datastore-docs]
115119

116-
Follow the [activation instructions][cloud-datastore-activation] to use the Google Cloud Datastore API with your project.
120+
*Follow the [activation instructions][cloud-datastore-activation] to use the Google Cloud Datastore API with your project.*
117121

118-
See the [gcloud-node Datastore API documentation][gcloud-datastore-docs] to learn how to interact with the Cloud Datastore using this library.
122+
#### Preview
119123

120124
```js
121125
var gcloud = require('gcloud');
@@ -135,10 +139,8 @@ dataset.get(dataset.key(['Product', 'Computer']), function(err, entity) {
135139
// Save data to your dataset.
136140
var blogPostData = {
137141
title: 'How to make the perfect homemade pasta',
138-
tags: ['pasta', 'homemade'],
139142
author: 'Andrew Chilton',
140-
isDraft: true,
141-
wordCount: 450
143+
isDraft: true
142144
};
143145

144146
var blogPostKey = dataset.key('BlogPost');
@@ -162,11 +164,13 @@ dataset.save({
162164
});
163165
```
164166

167+
165168
## Google Cloud Storage
166169

167-
[Google Cloud Storage][cloud-storage] ([docs][cloud-storage-docs]) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.
170+
- [API Documentation][gcloud-storage-docs]
171+
- [Official Documentation][cloud-storage-docs]
168172

169-
See the [gcloud-node Storage API documentation][gcloud-storage-docs] to learn how to connect to Cloud Storage using this library.
173+
#### Preview
170174

171175
```js
172176
var fs = require('fs');
@@ -199,13 +203,15 @@ var fileStream = bucket.file('photo.jpg').createReadStream();
199203
fileStream.pipe(fs.createWriteStream('/local/photo.jpg'));
200204
```
201205

206+
202207
## Google Cloud Pub/Sub (Beta)
203208

204209
> This is a *Beta* release of Google Cloud Pub/Sub. This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
205210
206-
[Google Cloud Pub/Sub][cloud-pubsub] ([docs][cloud-pubsub-docs]) allows you to connect your services with reliable, many-to-many, asynchronous messaging hosted on Google's infrastructure. Cloud Pub/Sub automatically scales as you need it and provides a foundation for building your own robust, global services.
211+
- [API Documentation][gcloud-pubsub-docs]
212+
- [Official Documentation][cloud-pubsub-docs]
207213

208-
See the [gcloud-node Pub/Sub API documentation][gcloud-pubsub-docs] to learn how to use Cloud Pub/Sub with this library.
214+
#### Preview
209215

210216
```js
211217
var gcloud = require('gcloud');
@@ -241,12 +247,15 @@ topic.subscribe('new-subscription', function(err, subscription) {
241247
});
242248
```
243249

250+
244251
## Google Cloud Search (Alpha)
252+
245253
> This is an *Alpha* release of Google Cloud Search. This feature is not covered by any SLA or deprecation policy and may be subject to backward-incompatible changes.
246254
247-
[Google Cloud Search][cloud-search] ([docs][cloud-search-docs]) allows you to quickly perform full-text and geospatial searches against your data without having to spin up your own instances and without the hassle of managing and maintaining a search service.
255+
- [API Documentation][gcloud-search-docs]
256+
- [Official Documentation][cloud-search-docs]
248257

249-
See the [gcloud-node Search API documentation][gcloud-search-docs] to learn how to store and query your indexes and documents using this library.
258+
#### Preview
250259

251260
```js
252261
var gcloud = require('gcloud');
@@ -300,31 +309,25 @@ Apache 2.0 - See [COPYING](COPYING) for more information.
300309
[gcloud-pubsub-docs]: https://googlecloudplatform.github.io/gcloud-node/#/docs/pubsub
301310
[gcloud-search-docs]: https://googlecloudplatform.github.io/gcloud-node/#/docs/search
302311
[gcloud-storage-docs]: https://googlecloudplatform.github.io/gcloud-node/#/docs/storage
312+
303313
[gcloud-todos]: https://github.com/GoogleCloudPlatform/gcloud-node-todos
304314
[gitnpm]: https://github.com/stephenplusplus/gitnpm
305315
[gcloud-kvstore]: https://github.com/stephenplusplus/gcloud-kvstore
316+
[hya-wave]: https://wav.hya.io
317+
[hya-io]: https://hya.io
306318

307319
[dev-console]: https://console.developers.google.com/project
308320
[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
309321

310322
[googleapis]: https://github.com/google/google-api-nodejs-client
311323

312-
[cloud-bigquery]: https://cloud.google.com/bigquery/
313324
[cloud-bigquery-docs]: https://cloud.google.com/bigquery/what-is-bigquery
314325

315-
[cloud-datastore]: https://cloud.google.com/datastore/
316326
[cloud-datastore-docs]: https://cloud.google.com/datastore/docs
317327
[cloud-datastore-activation]: https://cloud.google.com/datastore/docs/activate
318328

319-
[cloud-pubsub]: https://cloud.google.com/pubsub/
320329
[cloud-pubsub-docs]: https://cloud.google.com/pubsub/docs
321330

322-
[cloud-search]: https://cloud.google.com/search/
323331
[cloud-search-docs]: https://cloud.google.com/search/
324332

325-
[cloud-storage]: https://cloud.google.com/storage/
326333
[cloud-storage-docs]: https://cloud.google.com/storage/docs/overview
327-
[cloud-storage-create-bucket]: https://cloud.google.com/storage/docs/cloud-console#_creatingbuckets
328-
329-
[hya-wave]: https://wav.hya.io
330-
[hya-io]: https://hya.io

0 commit comments

Comments
 (0)