From 8728ad4018bf9c976cdc469af3d8a7ec89c04671 Mon Sep 17 00:00:00 2001 From: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Date: Sun, 7 Mar 2021 06:00:03 -0700 Subject: [PATCH] docs: fix readme (#52) I accidentally over-wrote the README with a synthtool run. --- README.rst | 45 +++++++++++++++++++++++++++++++++++++++------ synth.py | 1 + 2 files changed, 40 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index bfe57a44..6bf68b26 100644 --- a/README.rst +++ b/README.rst @@ -1,6 +1,23 @@ -Python Client for Google Cloud Dialogflowcx API +Python Client for Dialogflow CX API ================================================= +|beta| |pypi| |versions| + +`Dialogflow CX API`_: Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices). + +- `Client Library Documentation`_ +- `Product Documentation`_ + +.. |beta| image:: https://img.shields.io/badge/support-beta-orange.svg + :target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support +.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dialogflow-cx.svg + :target: https://pypi.org/project/google-cloud-dialogflow-cx/ +.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dialogflow-cx.svg + :target: https://pypi.org/project/google-cloud-dialogflow-cx/ +.. _Dialogflow CX API: https://cloud.google.com/dialogflow/cx/docs +.. _Client Library Documentation: https://googleapis.dev/python/dialogflow-cx/latest +.. _Product Documentation: https://cloud.google.com/dialogflow/cx/docs + Quick Start ----------- @@ -8,11 +25,12 @@ 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 Dialogflowcx API. +3. `Enable the Dialogflow CX 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 +.. _Enable the Dialogflow CX API.: https://cloud.google.com/dialogflow/cx/docs .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html Installation @@ -34,9 +52,10 @@ Mac/Linux .. code-block:: console - python3 -m venv + pip install virtualenv + virtualenv source /bin/activate - /bin/pip install /path/to/library + /bin/pip install google-cloud-dialogflow-cx Windows @@ -44,6 +63,20 @@ Windows .. code-block:: console - python3 -m venv + pip install virtualenv + virtualenv \Scripts\activate - \Scripts\pip.exe install \path\to\library + \Scripts\pip.exe install google-cloud-dialogflow-cx + +Next Steps +~~~~~~~~~~ + +- Read the `Client Library Documentation`_ for Cloud Dialogflow CX API + API to see other available methods on the client. +- Read the `Dialogflow CX 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. + +.. _Dialogflow CX API Product documentation: https://cloud.google.com/dialogflow/cx/docs +.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst \ No newline at end of file diff --git a/synth.py b/synth.py index 753ad349..4d680d18 100644 --- a/synth.py +++ b/synth.py @@ -40,6 +40,7 @@ excludes=[ "setup.py", "docs/index.rst", + "README.rst", "noxfile.py", f"scripts/fixup_dialogflowcx_{version}_keywords.py", ],