Skip to content
This repository has been archived by the owner on Jan 6, 2024. It is now read-only.

Commit

Permalink
docs: fix readme (#52)
Browse files Browse the repository at this point in the history
I accidentally over-wrote the README with a synthtool run.
  • Loading branch information
busunkim96 committed Mar 7, 2021
1 parent 47c7bf0 commit 8728ad4
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 6 deletions.
45 changes: 39 additions & 6 deletions README.rst
@@ -1,18 +1,36 @@
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
-----------

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
Expand All @@ -34,16 +52,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-dialogflow-cx
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-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
1 change: 1 addition & 0 deletions synth.py
Expand Up @@ -40,6 +40,7 @@
excludes=[
"setup.py",
"docs/index.rst",
"README.rst",
"noxfile.py",
f"scripts/fixup_dialogflowcx_{version}_keywords.py",
],
Expand Down

0 comments on commit 8728ad4

Please sign in to comment.