Add readme

1 files changed, 14 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..bf6405f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+PROMPT
+======
+
+A Go 1.18 generics based package to create a command line readline style prompt that gets you the type you ask for. Supports reading in complex types when the Prompter interface is being used. Falls back on fmt.Scan, which might fail.
+
+Usage:
+
+```go
+import "git.kiefte.eu/lapingvino/prompt"
+```
+
+And see example.
+
+Feel free to be inspired and include an improved version in your packages. This is not meant to be maintained.