1 files changed, 16 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8cabc1b
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# JED - Jacob's ed
+
+Jed is a line mode text editor written in Java. It is similar to ed but not a clone, infact the commands are changed. It currently works but has much room for improvement.
+
+## Building Jed
+
+```
+make
+sudo cp jed /usr/bin/jed && sudo cp jed.jar /usr/bin/jed.jar
+```
+
+## TODO
+
+- Rewrite Parser function
+
+- Add Regex support
+\ No newline at end of file