Skip to content

Commit

Permalink
Added a bit of documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
githuib committed Feb 15, 2024
1 parent be24bfe commit 9d1c84e
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
```

0 comments on commit 9d1c84e

Please sign in to comment.