From 8fd81d4b8c12e670379d14599de78512bd329070 Mon Sep 17 00:00:00 2001 From: Stephen Margheim Date: Tue, 20 Aug 2024 17:34:17 +0200 Subject: [PATCH] Tweak headers --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a0d2533..ed78d7b 100644 --- a/README.md +++ b/README.md @@ -18,7 +18,7 @@ If bundler is not being used to manage dependencies, install the gem by executin gem install prompts ``` -## Usage +## Philosophy Prompts aims to provide beautiful and user-friendly forms for your command-line applications while keeping both the API and the implementation simple. This means Prompts is built with constraints in mind. @@ -28,6 +28,8 @@ In this way, this new library is similar to [Charm's Huh library](https://github Finally, to keep internals simple, Prompts expects users to build and provide their own ANSI-formatted strings. However, we do make available the [`fmt`](https://github.com/hopsoft/fmt) gem as the recommended way to generate well formatted ANSI strings. +## Available Prompts + ### Text A `Text` prompt will prompt the user with the given question, accept their input, and then return it: