From 9e8b22a037ec11d2a29f508cd0d6de8a472cc992 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Peter=20V=C3=BDboch?= <47027005+petereon@users.noreply.github.com> Date: Wed, 4 Jan 2023 20:12:03 +0100 Subject: [PATCH] docs: adding install instructions --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 39764b5..08e0b38 100644 --- a/README.md +++ b/README.md @@ -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