Skip to content

Commit

Permalink
docs: adding install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
petereon authored Jan 4, 2023
1 parent 8c0f8c1 commit 9e8b22a
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,18 @@

yakh (Yet Another Keypress Handler) tries to handle keypresses from the stdin in the terminal in high-level platform indepdendent manner.

## Installation

Yakh can be installed from [PyPI](https://pypi.org/project/python-yakh/) using,
```sh
pip install python-yakh
```

or GitHub itself using poetry,
```sh
poetry add git+https://github.com/petereon/yakh.git
```

## Usage

```python
Expand Down

0 comments on commit 9e8b22a

Please sign in to comment.