aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorEugene Triguba <eugenetriguba@gmail.com>2023-04-22 22:40:18 -0400
committerEugene Triguba <eugenetriguba@gmail.com>2023-04-22 22:40:18 -0400
commit7cfc54694fd7b6f9f8757db53f4c98e93b8b1d2c (patch)
tree23a1864d1b694c9d495e4bea0443f8fe5b7397f2
parentUpdate taskipy poetry plugin branch commit reference (diff)
downloadpoetry-plugin-taskipy2-7cfc54694fd7b6f9f8757db53f4c98e93b8b1d2c.zip
Add basic description and installation instructions
-rw-r--r--README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/README.md b/README.md
index be940c8..6b62199 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,34 @@
# 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
+CLI to run your regular taskipy tasks.
+
+## Installation
+
+There are multiple ways to install this plugin and the way you should install it depends on
+how you've installed Poetry itself.
+
+### With Poetry installed via the official installer
+
+With the official installer, you can use the Poetry CLI itself to install the plugin.
+
+```
+$ poetry self add poetry-plugin-taskipy
+```
+
+### With Poetry installed via Pipx
+
+If you installed Poetry via Pipx, you'll want to utilize the `inject` command.
+
+```
+$ pipx inject poetry poetry-plugin-taskipy
+```
+
+### With Poetry installed via Pip
+
+If you installed Poetry via Pip, you can install the plugin in that same environment.
+
+```
+$ pip install poetry-plugin-taskipy
+```