1 files changed, 23 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9b67a96
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+Overview
+--------
+
+lua-term is a Lua module for manipulating a terminal.
+
+Installation
+------------
+
+lua-term is available on Luarocks.
+
+Usage
+-----
+
+```lua
+    local term   = require 'term'
+    local colors = term.colors -- or require 'term.colors'
+
+    print(term.isatty(io.stdout)) -- true if standard output goes to the terminal
+
+    print(color.red 'hello')
+    print(color.red .. 'hello' .. color.reset)
+    print(color.red, 'hello', color.reset)
+```