Update and rename README.rdoc to README.md

mculp · Oct 16, 2015 · caa4092 · caa4092
1 parent bf2c3fc
commit caa4092
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 28 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+WHAT THE HELL IS THIS?
+======================
+
+This is a hacked together project that puts a front-end that shows a dashboard for multiple running instances of MPOS, a PHP-based bitcoin / altcoin mining front-end/API.
+
+### Why would you do that?
+
+Because chunkypools.com allowed users to mine 10+ coins, with 3 different algorithms, at one point. MPOS is a single coin front-end.
+
+HOW DO I DO THAT?
+===============
+
+- fork this repo
+- change stuff that doesn't apply to you
+- install dependencies, such as rethinkDB and rails of course
+- run this like any other rails app
+
+WHY DIDN'T YOU MAKE THIS EASIER TO FORK AND CONFIGURE?
+======================================================
+
+See the fourth and fifth words of the "WHAT THE HELL IS THIS?" section. Include the fact that I haven't touched the code in a year and a half.
+
+CONTACT YOUR BOY
+================
+
+Matt Culpepper / @_mculp / matt[at]culpepper.co
diff --git a/README.rdoc b/README.rdoc