chore: init

1 files changed, 13 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0ad027d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# sh
+
+Conveniently call external processes from Haskell.
+
+## Description
+
+This library makes it convenient to run external processes in your Haskell program.
+
+It offers a single quasi quoter `sh` to run external processes.
+
+The program's exit code, standard output and standard error can be obtained by parameterizing its output type to ``ExitCode``, `(ExitCode, String)`, `(ExitCode, String, String)`, `String`, `(String, String)`, respectively. Instead of `String`, you may chose `ByteString` or `Text`, in both lazy and strict variants, as outputs.
+
+Arguments passed to `sh` are automatically passed to the process in a type-safe way, and appropriately quoted.