11# Google Cloud Platform C++ Client Libraries
22
3+ C++ Idiomatic Clients for [ Google Cloud Platform] [ cloud-platform ] services.
4+
35[ ![ Travis CI status] [ travis-shield ]] [ travis-link ]
46[ ![ AppVeyor CI status] [ appveyor-shield ]] [ appveyor-link ]
57[ ![ Codecov Coverage status] [ codecov-shield ]] [ codecov-link ]
68[ ![ Documentation] [ doxygen-shield ]] [ doxygen-link ]
79
10+ - [ Google Cloud Platform Documentation] [ cloud-platform-docs ]
11+
812[ travis-shield ] : https://travis-ci.org/GoogleCloudPlatform/google-cloud-cpp.svg?branch=master
913[ travis-link ] : https://travis-ci.org/GoogleCloudPlatform/google-cloud-cpp/builds
1014[ appveyor-shield ] : https://ci.appveyor.com/api/projects/status/d6srbtprnie4ufrx/branch/master?svg=true
1317[ codecov-link ] : https://codecov.io/gh/GoogleCloudPlatform/google-cloud-cpp
1418[ doxygen-shield ] : https://img.shields.io/badge/documentation-master-brightgreen.svg
1519[ doxygen-link ] : http://GoogleCloudPlatform.github.io/google-cloud-cpp/
20+ [ cloud-platform ] : https://cloud.google.com/
21+ [ cloud-platform-docs ] : https://cloud.google.com/docs/
1622
17- This repo contains experimental client libraries for the following APIs:
23+ This library supports the following Google Cloud Platform services with clients
24+ at an [ Alpha] ( #versioning ) quality level:
1825
19- * [ Google Cloud Bigtable] ( bigtable/ )
26+ - [ Google Cloud Bigtable] ( bigtable )
2027
2128The libraries in this code base likely do not (yet) cover all the available
2229APIs. See the [ ` googleapis ` repo] ( https://github.com/googleapis/googleapis )
2330for the full list of APIs callable using gRPC.
2431
32+ ## Quick Start
33+
2534To build the available libraries and run the tests, run the following commands
2635after cloning this repo:
2736
@@ -35,6 +44,26 @@ make all
3544make test
3645```
3746
47+ ## Versioning
48+
49+ This library follows [ Semantic Versioning] ( http://semver.org/ ) . Please note it
50+ is currently under active development. Any release versioned 0.x.y is subject to
51+ backwards incompatible changes at any time.
52+
53+ ** GA** : Libraries defined at a GA quality level are expected to be stable and
54+ all updates in the libraries are guaranteed to be backwards-compatible. Any
55+ backwards-incompatible changes will lead to the major version increment
56+ (1.x.y -> 2.0.0).
57+
58+ ** Beta** : Libraries defined at a Beta quality level are expected to be mostly
59+ stable and we're working towards their release candidate. We will address issues
60+ and requests with a higher priority.
61+
62+ ** Alpha** : Libraries defined at an Alpha quality level are still a
63+ work-in-progress and are more likely to get backwards-incompatible updates.
64+ Additionally, it's possible for Alpha libraries to get deprecated and deleted
65+ before ever being promoted to Beta or GA.
66+
3867## Contributing changes
3968
4069See [ ` CONTRIBUTING.md ` ] ( CONTRIBUTING.md ) for details on how to contribute to
0 commit comments