aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2023-04-30 13:05:15 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2023-04-30 13:05:15 -0400
commitedf6f1d46ac32210f2a999550198f72740e9c3c3 (patch)
tree786104e2725e2be01666f71b9a929fee81439979
parentRun poetry update to update a few dependencies (diff)
downloadpoetry-plugin-taskipy2-edf6f1d46ac32210f2a999550198f72740e9c3c3.zip
Add basic usage example
-rw-r--r--README.md35
1 files changed, 34 insertions, 1 deletions
diff --git a/README.md b/README.md
index 6b62199..727afd9 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,4 @@
-# Poetry Plugin for Taskipy
+# Poetry plugin for taskipy
This package is a plugin for the Poetry CLI that directly integrates [taskipy](https://github.com/taskipy/taskipy)
into it. With this plugin installed, you may then use a `task` subcommand on the Poetry
@@ -32,3 +32,36 @@ If you installed Poetry via Pip, you can install the plugin in that same environ
```
$ pip install poetry-plugin-taskipy
```
+
+## Usage
+
+Once you've installed the taskipy poetry plugin, you'll now see a `task` subcommand on the base `poetry` CLI.
+
+```
+$ poetry
+...
+
+Available commands:
+ ...
+ task Run a taskipy task.
+ ...
+```
+
+
+If we assume the following basic `pyproject.toml` file in the current directory or a parent directory:
+
+```toml
+[tool.poetry]
+name = "project"
+version = "0.1.0"
+
+[tool.taskipy.tasks]
+test_echo = "echo 'test'"
+```
+
+We may then run:
+
+```
+$ poetry task test_echo
+test
+```