aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2024-11-06 21:58:01 -0600
committerChristian Cleberg <hello@cleberg.net>2024-11-06 21:58:01 -0600
commit9d400ecdf336904b0da487e23b14c8a0eadfd41c (patch)
tree4052c2e34013eddbaa29c64e7d4fe2cd9ee6ff52 /README.md
parent3d54f3422acc610ef8c80e72db89e9bcbe88779f (diff)
downloadyoshi-cli-9d400ecdf336904b0da487e23b14c8a0eadfd41c.tar.gz
yoshi-cli-9d400ecdf336904b0da487e23b14c8a0eadfd41c.tar.bz2
yoshi-cli-9d400ecdf336904b0da487e23b14c8a0eadfd41c.zip
update README
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 7 insertions, 8 deletions
diff --git a/README.md b/README.md
index 0ecf2bd..f6ae396 100644
--- a/README.md
+++ b/README.md
@@ -21,21 +21,20 @@ information.
[(Back to top)](#table-of-contents)
-To run the script locally, run the following commands:
+## PyPi
```bash
-git clone REPO_URL
+pip install yoshi-cli
```
-```bash
-cd yoshi
-```
+## Manual
-```bash
-pip3 install -r requirements.txt
-```
+To run the script locally, run the following commands:
```bash
+git clone REPO_URL
+cd yoshi
+pip3 install -r requirements.txt
python3 main.py --help
```