From 9d1c84e1e851414b1260f62697ebb865e6c4d207 Mon Sep 17 00:00:00 2001 From: Huib Piguillet Date: Thu, 15 Feb 2024 16:38:07 +0100 Subject: [PATCH] Added a bit of documentation --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index ab63190..d8848f4 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,28 @@ [![Poetry](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/githuib/powerchord/master/assets/logo.json)](https://pypi.org/project/powerchord) [![PyPI - Version](https://img.shields.io/pypi/v/powerchord)](https://pypi.org/project/powerchord/#history) [![PyPI - Python Versions](https://img.shields.io/pypi/pyversions/powerchord)](https://pypi.org/project/powerchord) + +## Installation + +```sh +python3 -m pip install -U powerchord +``` + +## Usage + +Currently, tasks need to be specified in `pyproject.toml`: + +```toml +# tasks to do +[tool.powerchord.tasks] +do-something = "command --foo bar /path/to/happiness" +do-something-else = "..." +you-get-the-idea = "..." + +# config +[tool.powerchord.verbosity] +# show output of successful tasks +success = ["info", "error"] # default [] +# show output of failed tasks +fail = ["info", "error"] # default ["info", "error"] +```