From 34a3279e2f8b6593d71f1c5452ab861f2fe606e9 Mon Sep 17 00:00:00 2001 From: Sebastian Lohff Date: Sun, 16 Aug 2020 15:13:22 +0200 Subject: [PATCH] Improve README.md a tiny bit --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 09bc670..b60181b 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ -# CLI-Intermission -Tool to easily ask your user questions on the commandline. Interactive! -...by abusing python prompt-toolkit's `Buffer` class. +# Clintermission - Python CLI Intermission Library +`clintermission` is a small Python library designed to quickly get a selection +of a single or multiple items from a user. The menu shown is explicitly not a +fullscreen menu so the user can use information in their console history to +make a selection. -Highly inspired by [go promptui](https://github.com/manifoldco/promptui) +The menu is implemented by using `prompt-toolkit`'s `Buffer` class. + +Inspired by [go promptui](https://github.com/manifoldco/promptui).