From 96873eba294ccda7e3ece7b43e10e46d01e3318f Mon Sep 17 00:00:00 2001
From: Kevin Herrera <kevin@herrera.io>
Date: Mon, 17 Jan 2022 01:41:50 +0000
Subject: [PATCH] Creating the README.

---
 .gitignore |  3 +++
 README.md  | 24 ++++++++++++++++++++++++
 2 files changed, 27 insertions(+)
 create mode 100644 README.md

diff --git a/.gitignore b/.gitignore
index 68c1af0..23e1740 100644
--- a/.gitignore
+++ b/.gitignore
@@ -14,6 +14,9 @@
 # Except the license.
 !/LICENSE
 
+# Except the README.
+!/README.md
+
 # Except the examples.
 !/examples/
 !/examples/**
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2893047
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+CarLI
+=====
+
+A library for rapid command line tool development.
+
+CarLI is a command line application framework for developing application that provide a single
+command and multiple commands. The framework also provides error types tailored for a command
+line experience as well as supporting test input and output streams other than those provided
+by [`std::io`].
+
+See [`command::Main`] for a complete example.
+
+[`command::Main`]: https://docs.rs/carli/latest/carli/command/trait.Main.html
+[`std::io`]: https://doc.rust-lang.org/1.57.0/std/io/index.html
+
+Requirements
+------------
+
+- Rust 1.57+
+
+Documentation
+-------------
+
+Please see [docs.rs](https://docs.rs/carli/latest/carli).