aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorQuentin <quentin@deuxfleurs.fr>2021-12-08 16:30:28 +0100
committerQuentin <quentin@deuxfleurs.fr>2021-12-08 16:31:20 +0100
commit322e949de0b416118365fbfb9448e5e5a1be6b23 (patch)
tree20cba559695cc33320149b192fae615a79bb692e
parentabccfb88b8cc873b4f399d38a3151bbbe12c360d (diff)
downloadmknet-322e949de0b416118365fbfb9448e5e5a1be6b23.tar.gz
mknet-322e949de0b416118365fbfb9448e5e5a1be6b23.zip
Update documentation to use pip
-rw-r--r--README.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/README.md b/README.md
index 270d616..43574e7 100644
--- a/README.md
+++ b/README.md
@@ -1,19 +1,19 @@
# mknet
-Show usage:
+## Installation
-```help
-python3 main.py
+```bash
+sudo pip3 install https://git.deuxfleurs.fr/trinity-1686a/mknet
```
-## Example
+## Usage
```bash
sudo rm -rf /tmp/garage-testnet/ # always start by deleting previous run
-sudo python3 main.py create ./config.yml
-sudo python3 main.py run-all example/deploy_garage.sh
-sudo python3 main.py run dc1:dc1s1 garage -c /tmp/garage-testnet/dc1/dc1s1/garage.toml status
-sudo python3 main.py destroy
+sudo mknet create ./config.yml
+sudo mknet run-all example/deploy_garage.sh
+sudo mknet run dc1:dc1s1 garage -c /tmp/garage-testnet/dc1/dc1s1/garage.toml status
+sudo mknet destroy
```
## Instrumented daemons