aboutsummaryrefslogtreecommitdiff
path: root/v_windows/v/vlib/readline/README.md
diff options
context:
space:
mode:
authorIndrajith K L2022-12-03 17:00:20 +0530
committerIndrajith K L2022-12-03 17:00:20 +0530
commitf5c4671bfbad96bf346bd7e9a21fc4317b4959df (patch)
tree2764fc62da58f2ba8da7ed341643fc359873142f /v_windows/v/vlib/readline/README.md
downloadcli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.tar.gz
cli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.tar.bz2
cli-tools-windows-f5c4671bfbad96bf346bd7e9a21fc4317b4959df.zip
Adds most of the toolsHEADmaster
Diffstat (limited to 'v_windows/v/vlib/readline/README.md')
-rw-r--r--v_windows/v/vlib/readline/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/v_windows/v/vlib/readline/README.md b/v_windows/v/vlib/readline/README.md
new file mode 100644
index 0000000..edd4682
--- /dev/null
+++ b/v_windows/v/vlib/readline/README.md
@@ -0,0 +1,20 @@
+# Readline
+
+The `readline` module let you await and read user input
+from a terminal in an easy and structured manner.
+
+The module provides an easy way to prompt the user for
+questions or even make a REPL or an embedded console.
+
+Use `readline.Readline` if you want to include more
+advanced features such as history or simply use
+`readline.read_line('Please confirm (y/n):')` directly
+for one-off user interactions.
+
+# Usage
+
+```v ignore
+import readline { Readline }
+
+Readline.read_line('Continue?: (y/n)')
+```