summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoberto Berto <roberto.berto@gmail.com>2023-12-13 14:40:02 -0300
committerRoberto Berto <roberto.berto@gmail.com>2023-12-13 14:40:02 -0300
commit1241b73ac689972b5743bc4b9c3c3baa28fbe095 (patch)
tree13e61bd5f7bd508668255a8687db37189344b7f6
parent5a751286aeb68ce3680d24b031b2dce91c45a2b6 (diff)
downloadpyvyos-1241b73ac689972b5743bc4b9c3c3baa28fbe095.tar.gz
pyvyos-1241b73ac689972b5743bc4b9c3c3baa28fbe095.zip
read the docs in readme.md
-rw-r--r--README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5ac7560..1a19b4b 100644
--- a/README.md
+++ b/README.md
@@ -2,12 +2,13 @@
PyVyOS is a Python library for interacting with VyOS devices via their API. This documentation provides a guide on how to use PyVyOS to manage your VyOS devices programmatically.
+You can find the complete PyVyOS documentation on [Read the Docs](https://pyvyos.readthedocs.io/en/latest/).
+
## Installation
You can install PyVyOS using pip:
-```
-bash
+```bash
pip install pyvyos
```