From bbb465994ff6418ee014a382bada14b10c9ddf81 Mon Sep 17 00:00:00 2001 From: Matt Date: Sat, 12 Apr 2014 14:10:55 -0600 Subject: [PATCH] Updated readme to be clear that this is simply a node.js module. --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 777b71a..86e4e6d 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,12 @@ High performance Stratum poolserver in Node.js. One instance of this software ca pools, each with their own daemon and stratum port :) #### Notice -This project does not do any payment processing. For a full featured portal that uses this module, see -[NOMP (Node Open Mining Portal)](https://github.com/zone117x/node-open-mining-portal). It handles payments, website -front-end, database layer, mutli-coin/pool support, auto-switching miners between coins/pools, etc.. The portal also -has an [MPOS](https://github.com/MPOS/php-mpos) compatibility mode so that the it can function as a drop-in-replacement -for [python-stratum-mining](https://github.com/Crypto-Expert/stratum-mining). +This is a module for Node.js that will do nothing on its own. Unless you're a Node.js developer who would like to +handle stratum authentication and raw share data then this module will not be of use to you. For a full featured portal +that uses this module, see [NOMP (Node Open Mining Portal)](https://github.com/zone117x/node-open-mining-portal). It +handles payments, website front-end, database layer, mutli-coin/pool support, auto-switching miners between coins/pools, +etc.. The portal also has an [MPOS](https://github.com/MPOS/php-mpos) compatibility mode so that the it can function as +a drop-in-replacement for [python-stratum-mining](https://github.com/Crypto-Expert/stratum-mining). [![Build Status](https://travis-ci.org/zone117x/node-stratum-pool.png?branch=master)](https://travis-ci.org/zone117x/node-stratum-pool)