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

Commit 8728ad4

Browse files
authored
docs: fix readme (#52)
I accidentally over-wrote the README with a synthtool run.
1 parent 47c7bf0 commit 8728ad4

File tree

2 files changed

+40
-6
lines changed

2 files changed

+40
-6
lines changed

README.rst

Lines changed: 39 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,36 @@
1-
Python Client for Google Cloud Dialogflowcx API
1+
Python Client for Dialogflow CX API
22
=================================================
33

4+
|beta| |pypi| |versions|
5+
6+
`Dialogflow CX API`_: Builds conversational interfaces (for example, chatbots, and voice-powered apps and devices).
7+
8+
- `Client Library Documentation`_
9+
- `Product Documentation`_
10+
11+
.. |beta| image:: https://img.shields.io/badge/support-beta-orange.svg
12+
:target: https://github.com/googleapis/google-cloud-python/blob/master/README.rst#beta-support
13+
.. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-dialogflow-cx.svg
14+
:target: https://pypi.org/project/google-cloud-dialogflow-cx/
15+
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-dialogflow-cx.svg
16+
:target: https://pypi.org/project/google-cloud-dialogflow-cx/
17+
.. _Dialogflow CX API: https://cloud.google.com/dialogflow/cx/docs
18+
.. _Client Library Documentation: https://googleapis.dev/python/dialogflow-cx/latest
19+
.. _Product Documentation: https://cloud.google.com/dialogflow/cx/docs
20+
421
Quick Start
522
-----------
623

724
In order to use this library, you first need to go through the following steps:
825

926
1. `Select or create a Cloud Platform project.`_
1027
2. `Enable billing for your project.`_
11-
3. Enable the Google Cloud Dialogflowcx API.
28+
3. `Enable the Dialogflow CX API.`_
1229
4. `Setup Authentication.`_
1330

1431
.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
1532
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
33+
.. _Enable the Dialogflow CX API.: https://cloud.google.com/dialogflow/cx/docs
1634
.. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html
1735

1836
Installation
@@ -34,16 +52,31 @@ Mac/Linux
3452

3553
.. code-block:: console
3654
37-
python3 -m venv <your-env>
55+
pip install virtualenv
56+
virtualenv <your-env>
3857
source <your-env>/bin/activate
39-
<your-env>/bin/pip install /path/to/library
58+
<your-env>/bin/pip install google-cloud-dialogflow-cx
4059
4160
4261
Windows
4362
^^^^^^^
4463

4564
.. code-block:: console
4665
47-
python3 -m venv <your-env>
66+
pip install virtualenv
67+
virtualenv <your-env>
4868
<your-env>\Scripts\activate
49-
<your-env>\Scripts\pip.exe install \path\to\library
69+
<your-env>\Scripts\pip.exe install google-cloud-dialogflow-cx
70+
71+
Next Steps
72+
~~~~~~~~~~
73+
74+
- Read the `Client Library Documentation`_ for Cloud Dialogflow CX API
75+
API to see other available methods on the client.
76+
- Read the `Dialogflow CX API Product documentation`_ to learn
77+
more about the product and see How-to Guides.
78+
- View this `README`_ to see the full list of Cloud
79+
APIs that we cover.
80+
81+
.. _Dialogflow CX API Product documentation: https://cloud.google.com/dialogflow/cx/docs
82+
.. _README: https://github.com/googleapis/google-cloud-python/blob/master/README.rst

synth.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@
4040
excludes=[
4141
"setup.py",
4242
"docs/index.rst",
43+
"README.rst",
4344
"noxfile.py",
4445
f"scripts/fixup_dialogflowcx_{version}_keywords.py",
4546
],

0 commit comments

Comments
 (0)