Added initial readme file

1 files changed, 35 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b2284a1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,35 @@
+## Description
+Noteless provides a simple command line interface to note taking.
+
+What makes this different than simply using a command line text editor is there
+is no need to type paths or file extensions. It handles all of the file
+management without having to change directories.
+
+
+## Prerequisites
+*   gcc
+*   gcc-c++
+*   make
+
+
+## Installation
+*   Clone this repository
+*   cd noteless
+*   make
+
+There is currently no **make install** for noteless yet, but the binary will
+run from anywhere. Just symlink it to **~/bin/noteless** (or just copy it
+there), add ~/bin to your path, and you should be good to go.
+
+
+## Commands
+**ls**
+Lists all notes
+
+**find**
+Performs a case insensitive search of all notes, displaying only the lines that
+match along with their line numbers and files from which they came.
+
+**help**
+Displays the help text.
+