From 7cfc54694fd7b6f9f8757db53f4c98e93b8b1d2c Mon Sep 17 00:00:00 2001 From: Eugene Triguba Date: Sat, 22 Apr 2023 22:40:18 -0400 Subject: Add basic description and installation instructions --- README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) 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 +``` -- cgit v1.2.3