docs: install first alpha release

StellarCN · Aug 14, 2019 · 76dab7d · 76dab7d
1 parent 4ef5a04
commit 76dab7d
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 10 deletions.
diff --git a/README.rst b/README.rst
@@ -1,7 +1,7 @@
 py-stellar-sdk
 ==============
 
-.. image:: https://img.shields.io/travis/StellarCN/py-stellar-base.svg?style=flat-square&maxAge=1800
+.. image:: https://img.shields.io/travis/StellarCN/py-stellar-base/v2?style=flat-square&maxAge=1800
     :alt: Travis (.org)
     :target: https://travis-ci.org/StellarCN/py-stellar-base/
 
@@ -13,7 +13,7 @@ py-stellar-sdk
     :alt: Codecov
     :target: https://codecov.io/gh/StellarCN/py-stellar-base
 
-.. image:: https://img.shields.io/codeclimate/maintainability/overcat/py-stellar-sdk?style=flat-square&maxAge=1800
+.. image:: https://img.shields.io/codeclimate/maintainability/overcat/py-stellar-sdk/v2?style=flat-square&maxAge=1800
     :alt: Code Climate maintainability
     :target: https://codeclimate.com/github/overcat/py-stellar-sdk/maintainability
 

diff --git a/docs/index.rst b/docs/index.rst
@@ -36,6 +36,7 @@ py-stellar-sdk
     :alt: PyPI - Implementation
     :target: https://pypi.python.org/pypi/stellar-sdk
 
+**This is a alpha release, please do not use it in production environment, feedback is welcome :-)**
 
 py-stellar-sdk is a Python library for communicating with
 a `Stellar Horizon server`_. It is used for building Stellar apps on Python. It supports **Python 3.6+** as

diff --git a/docs/install.rst b/docs/install.rst
@@ -11,7 +11,7 @@ To install py-stellar-sdk, use pipenv to install the module:
 
 .. code-block:: text
 
-    pipenv install stellar-sdk
+    pipenv install stellar-sdk==2.0.0a1
 
 If you're not using `pipenv <https://docs.pipenv.org/>`_, you should.
 Otherwise, you can install it via plain old `pip <https://pip.pypa.io/en/stable/quickstart/>`_. More on installing Python
@@ -23,16 +23,11 @@ Via Source Code
 
 Please use the code on pypi whenever possible. The latest code may be unstable.
 
-You can install it from source code via pip:
-
-.. code-block:: bash
-
-    pip install -U git+git://github.com/StellarCN/py-stellar-base
-
-And you can always clone `the repository <https://github.com/StellarCN/py-stellar-base>`_ directly, and install it locally:
+You can clone `the repository <https://github.com/StellarCN/py-stellar-base>`_ directly, and install it locally:
 
 .. code-block:: bash
 
     git clone https://github.com/StellarCN/py-stellar-base.git
     cd py-stellar-base
+    git checkout 2.0.0-alpha1
     pip install .