docs: include client library documentation in README.rst (#91)

parthea · web-flow · commit 3a6999d6196f · 2021-06-25T23:26:25.000Z
Fixes #90 🦕
diff --git a/README.rst b/README.rst
@@ -1,5 +1,23 @@
-Python Client for Google Cloud Billing API
-=================================================
+Python Client for Cloud Billing API
+===================================
+
+|ga| |pypi| |versions|
+
+`Cloud Billing API`_: Allows developers to manage billing for their Google Cloud Platform
+projects programmatically.
+
+- `Client Library Documentation`_
+- `Product Documentation`_
+
+.. |ga| image:: https://img.shields.io/badge/support-GA-gold.svg
+   :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#general-availability
+.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-billing.svg
+   :target: https://pypi.org/project/google-cloud-billing/
+.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-billing.svg
+   :target: https://pypi.org/project/google-cloud-billing/
+.. _Cloud Billing API: https://cloud.google.com/billing
+.. _Client Library Documentation: https://googleapis.dev/python/cloudbilling/latest
+.. _Product Documentation:  https://cloud.google.com/billing
 
 Quick Start
 -----------
@@ -8,12 +26,13 @@ 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 billing for your project.`_
-3. Enable the Google Cloud Billing API.
+3. `Enable the Cloud Billing API.`_
 4. `Setup Authentication.`_
 
 .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
 .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
-.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
+.. _Enable the Cloud Billing API.:  https://cloud.google.com/billing
+.. _Setup Authentication.: https://googleapis.github.io/google-cloud-python/latest/core/auth.html
 
 Installation
 ~~~~~~~~~~~~
@@ -34,16 +53,31 @@ Mac/Linux
 
 .. code-block:: console
 
-    python3 -m venv <your-env>
+    pip install virtualenv
+    virtualenv <your-env>
     source <your-env>/bin/activate
-    <your-env>/bin/pip install /path/to/library
+    <your-env>/bin/pip install google-cloud-billing
 
 
 Windows
 ^^^^^^^
 
 .. code-block:: console
 
-    python3 -m venv <your-env>
+    pip install virtualenv
+    virtualenv <your-env>
     <your-env>\Scripts\activate
-    <your-env>\Scripts\pip.exe install \path\to\library
+    <your-env>\Scripts\pip.exe install google-cloud-billing
+
+Next Steps
+~~~~~~~~~~
+
+-  Read the `Client Library Documentation`_ for Cloud Billing API
+   API to see other available methods on the client.
+-  Read the `Cloud Billing API Product documentation`_ to learn
+   more about the product and see How-to Guides.
+-  View this `README`_ to see the full list of Cloud
+   APIs that we cover.
+
+.. _Cloud Billing API Product documentation:  https://cloud.google.com/billing
+.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst
diff --git a/owlbot.py b/owlbot.py
@@ -24,7 +24,7 @@
 default_version = "v1"
 
 for library in s.get_staging_dirs(default_version):
-    excludes = ["setup.py", "docs/index.rst", "scripts/fixup*"]
+    excludes = ["setup.py", "README.rst", "docs/index.rst", "scripts/fixup*"]
     s.move(library, excludes=excludes)
 
 s.remove_staging_dirs()
