added markdown README

diff --git a/README.md b/README.md
new file mode 100644 (file)
index 0000000..5ab8fd9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,45 @@
+BlueChips is a simple finance tracking application designed for small groups of
+people with shared expenses. It was designed and developed by groups of
+students who got tired of the headaches of managing lots of little payments
+between roommates.
+
+Example Scenario
+----------------
+
+1. Larry lives with Curly and Moe.
+2. Larry gets the utility bill, and enters it as an expenditure on their
+BlueChips site. Everyone shares the utilities, so it's just an even split.
+3. A week later, Moe pays the rent. Curly has a smaller room, so he pays a
+smaller fraction of the rent.
+4. At any time, any user can visit the BlueChips site and see who needs to pay
+who how much in order to settle the books.
+5. After a few months, Moe has paid for a disproportionate amount of stuff, so
+the other roommates each make a transfer to Moe, and enter the amounts in
+BlueChips.
+
+Additional Features
+-------------------
+
+* Support for negative expenses
+* Uses any authentication mechanism which can set the REMOTE_USER environment
+variable, including authentication modules supported by Apache, nginx,
+lighttpd, and others.
+* Email notifications of changes (optional)
+* 100% test coverage
+
+Installation and Setup
+----------------------
+
+Install ``BlueChips`` using easy_install::
+
+    easy_install BlueChips
+
+Make a config file as follows::
+
+    paster make-config BlueChips config.ini
+
+Tweak the config file as appropriate and then setup the application::
+
+    paster setup-app config.ini
+
+Host the application behind an authentication layer which sets REMOTE_USER.

diff --git a/README.txt b/README.txt
deleted file mode 100644 (file)
index 776f128..0000000
--- a/README.txt
+++ /dev/null
@@ -1,19 +0,0 @@
-This file is for you to describe the BlueChips application. Typically
-you would include information such as the information below:
-
-Installation and Setup
-======================
-
-Install ``BlueChips`` using easy_install::
-
-    easy_install BlueChips
-
-Make a config file as follows::
-
-    paster make-config BlueChips config.ini
-
-Tweak the config file as appropriate and then setup the application::
-
-    paster setup-app config.ini
-
-Then you are ready to go.