From 540797e6ea38689e03a314105e8753bd2ff5f250 Mon Sep 17 00:00:00 2001
From: Michael Dvorkin <mike@dvorkin.net>
Date: Thu, 15 Aug 2013 12:04:10 -0700
Subject: [PATCH] Added README

---
 LICENSE    |  1 -
 README.md  | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 cmd/mop.go |  2 +-
 3 files changed, 66 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/LICENSE b/LICENSE
index afd13d9..6e65a05 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,5 +1,4 @@
 Copyright (c) 2013 Michael Dvorkin. All Rights Reserved.
-http://www.dvorkin.net || `mike` + `@` + `dvorkin` + `.net`
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e6fb666
--- /dev/null
+++ b/README.md
@@ -0,0 +1,65 @@
+## Welcome to Mop ##
+Mop is a command-line utility that displays up-to-date information about
+the U.S. markets and individual stocks. One picture is worth a thousand
+words:
+
+
+### Installing Mop ###
+Mop is implemented in Go and compiles down to a single executable file.
+
+    $ git clone git://github.com/michaeldv/mop.git
+    $ cd mop
+    $ go get          # <-- Download dependencies.
+    $ make run        # <-- Compile and runs mop.
+    $ make build      # <-- Build mop in current directory.
+    $ make install    # <-- Build mop and install it in $GOPATH/bin.
+
+
+### Using Mop ###
+For demonstartion purposes Mop comes preconfigured to track a number of
+stock tickers. You can easily change the default list by using the
+following keyboard commands:
+
+    +       Add stocks to the list.
+    -       Remove stocks from the list.
+    o       Change column sort order.
+    g       Group stocks by advancing/declining issues.
+    ?       Display help screen.
+    esc     Quit mop.
+
+When prompted please enter comma-delimited list of stock tickers. The list
+and other settings are stored in ``.moprc`` file in your ``$HOME`` directory.
+
+
+### Contributing ###
+Mop is my personal project that I've came up with to learn Go programming.
+Your comments, suggestions, and contributions are always welcome.
+
+* Fork the project on Github.
+* Make your feature addition or bug fix.
+* Commit, do not change program version, or commit history.
+* Send me commit URL (*do not* send pull requests).
+
+
+### License ###
+Copyright (c) 2013 Michael Dvorkin. All Rights Reserved.
+`mike` + `@dvorkin` + `.net` || `twitter.com/mid`
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/cmd/mop.go b/cmd/mop.go
index 43d032a..3004c0c 100644
--- a/cmd/mop.go
+++ b/cmd/mop.go
@@ -16,7 +16,7 @@ NO WARRANTIES OF ANY KIND WHATSOEVER. SEE THE LICENSE FILE FOR DETAILS.
 <u>Command</u>    <u>Description                                </u>
    +       Add stocks to the list.
    -       Remove stocks from the list.
-   o       Change default sorting order.
+   o       Change column sort order.
    g       Group stocks by advancing/declining issues.
    ?       Display this help screen.
   esc      Quit mop.