diff --git a/README.rst b/README.rst index ef2218f97..9ebcb1b24 100644 --- a/README.rst +++ b/README.rst @@ -42,17 +42,27 @@ Features Installation ------------ -Install the ``elasticsearch`` package with `pip -`_:: +Refer to the `Installation section `_ +of the getting started documentation. - $ python -m pip install elasticsearch -If your application uses async/await in Python you can install with -the ``async`` extra:: +Connecting +---------- - $ python -m pip install elasticsearch[async] +Refer to the `Connecting section `_ +of the getting started documentation. -Read more about `how to use asyncio with this project `_. + +Usage +----- + +* `Creating an index `_ +* `Indexing a document `_ +* `Getting documents `_ +* `Searching documents `_ +* `Updating documents `_ +* `Deleting documents `_ +* `Deleting an index `_ Compatibility @@ -74,38 +84,6 @@ Documentation for the client is `available on elastic.co`_ and `Read the Docs`_. .. _available on elastic.co: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/index.html .. _Read the Docs: https://elasticsearch-py.readthedocs.io -Quick Start ------------ - -.. code-block:: python - - # Import the client from the 'elasticsearch' module - >>> from elasticsearch import Elasticsearch - - # Instantiate a client instance - >>> client = Elasticsearch("http://localhost:9200") - - # Call an API, in this example `info()` - >>> resp = client.info() - - # View the result - >>> resp - { - "name" : "instance-name", - "cluster_name" : "cluster-name", - "cluster_uuid" : "cluster-uuid", - "version" : { - "number" : "7.14.0", - ... - }, - "tagline" : "You know, for Search" - } - - -You can read more about `configuring the client`_ in the documentation. - -.. _configuring the client: https://www.elastic.co/guide/en/elasticsearch/client/python-api/current/connecting.html - License -------