Просмотр исходного кода

Add installation instructions to README

Enis Afgan 10 лет назад
Родитель
Сommit
5f6102f514
1 измененных файлов с 15 добавлено и 1 удалено
  1. 15 1
      README.rst

+ 15 - 1
README.rst

@@ -31,6 +31,17 @@ the Alpha state.
    :alt: Documentation Status
 
 
+Installation
+~~~~~~~~~~~~
+Install the latest release from PyPi:
+
+.. code-block:: shell
+
+  pip install cloudbridge
+
+For other installation options, see the `installation page`_ in
+the documentation.
+
 Usage example
 ~~~~~~~~~~~~~
 
@@ -102,8 +113,11 @@ defined interface. If adding a completely new provider, take a look at the
 `provider development page`_ in the documentation.
 
 
+.. _`installation page`: http://cloudbridge.readthedocs.org/en/
+   latest/topics/install.html
 .. _`get started`: http://cloudbridge.readthedocs.org/en/latest/
     getting_started.html
 .. _`PEP8 style guide`: https://www.python.org/dev/peps/pep-0008/
-.. _`provider development page`: http://cloudbridge.readthedocs.org/en/latest/
+.. _`provider development page`: http://cloudbridge.readthedocs.org/
+   en/latest/
     topics/provider_development.html