aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Cleberg <hello@cleberg.net>2024-11-06 23:23:27 -0600
committerChristian Cleberg <hello@cleberg.net>2024-11-06 23:23:27 -0600
commit6dde4dd0bc5e5f91f89587c75a30c9ef7a24494c (patch)
tree6cf4b78ddd63a4606e19fcad423ed2e19ad2a268 /README.md
parentb5a5fadff88615c8da8a9feb80c86fd8adb238f5 (diff)
downloadyoshi-cli-6dde4dd0bc5e5f91f89587c75a30c9ef7a24494c.tar.gz
yoshi-cli-6dde4dd0bc5e5f91f89587c75a30c9ef7a24494c.tar.bz2
yoshi-cli-6dde4dd0bc5e5f91f89587c75a30c9ef7a24494c.zip
package as a cli app
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/README.md b/README.md
index f6ae396..8c04013 100644
--- a/README.md
+++ b/README.md
@@ -34,8 +34,7 @@ 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
+pip install .
```
# Usage
@@ -43,7 +42,7 @@ python3 main.py --help
[(Back to top)](#table-of-contents)
All commands can be passed to the program with the following template:
-`python3 main.py <COMMAND> <FLAG> <PARAMETER>`
+`python3 src/yoshi/cli.py <COMMAND> <FLAG> <PARAMETER>`
![Yoshi CLI Help](./examples/yoshi-help.png)