summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@baturin.org>2016-09-06 17:30:28 +0600
committerDaniil Baturin <daniil@baturin.org>2016-09-06 17:30:28 +0600
commit82dea5997dc05cc124c8723d99801df0dd9b5018 (patch)
tree20f854a038857fd59453d8333c089662d9564060
parentd01977e4206dff4f249a3fb9ac44ea9d907f148d (diff)
downloadpython-vyos-mgmt-82dea5997dc05cc124c8723d99801df0dd9b5018.tar.gz
python-vyos-mgmt-82dea5997dc05cc124c8723d99801df0dd9b5018.zip
Add links to PyPI and ReadTheDocs.
-rwxr-xr-xREADME.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/README.md b/README.md
index 3b7e86d..9492231 100755
--- a/README.md
+++ b/README.md
@@ -20,11 +20,17 @@ that detect errors and raise appropriate exceptions when an error occurs.
## API reference
-Will be on readthedocs soon.
+...is kept on ReadTheDocs. http://vymgmt.readthedocs.io
## Installation
-Will be on PyPI soon.
+The easiest way is to install from PyPI (https://pypi.python.org/pypi):
+
+```
+pip install vymgmt
+```
+
+Alternatively you can run the setup.py script to install it locally.
## Usage example