diff --git a/README.md b/README.md index 3f720a4..c703d51 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -[ ![Codeship Status for ahmedbodi/php-mpos](https://www.codeship.io/projects/b3003a70-61a3-0131-231e-26f75a0c690d/status?branch=master)](https://www.codeship.io/projects/12274) -#Description +# Description Stratum-mining is a pooled mining protocol. It is a replacement for *getwork* based pooling servers by allowing clients to generate work. The stratum protocol is described [here](http://mining.bitcoin.cz/stratum-mining) in full detail. This is a implementation of stratum-mining for scrypt based coins. It is compatible with *MPOS* as it complies with the standards of *pushpool*. The end goal is to build on these standards to come up with a more stable solution. @@ -8,18 +7,7 @@ The goal is to make a reliable stratum mining server for a wide range of coins u **NOTE:** This fork is still in development. Many features may be broken. Please report any broken features or issues. -#Donations -* BTC: 18Xg4qP6RUvpeajanKPt5PDvvcqvU2pP6d -* BTE: 8UJLskr8eDYATvYzmaCBw3vbRmeNweT3rW -* DGC: DSBb5KmGWYKMJjxk3rETtvpk9sPqgCCYAw -* LTC: Lg4kXMqPsmMHrGr81LLe8oHpbsMiWiuMSB -* WDC: WeVFgZQsKSKXGak7NJPp9SrcUexghzTPGJ -* Doge: DLtBRYtNCzfiZfcpUeEr8KPvy5k1aR7jca -* SRC: sMP2wHN5H2ik7FQDPjhSzFZUWux75BYZGe -* ARG: AQvXPWVqGzcpH2j2XSRG7X5R9nA3y9D9aQ -* Cryptsy Trade Key: ec13d183e304326ebd41258d6ae7188e303866fe - -#Features +# Features * Stratum Mining Pool * Solved Block Confirmation @@ -36,7 +24,7 @@ The goal is to make a reliable stratum mining server for a wide range of coins u * Transaction Messaging Support -#Requirements +# Requirements *stratum-mining* is built in python. I have been testing it with 2.7.3, but it should work with other versions. The requirements for running the software are below. * Python 2.7+ * python-twisted @@ -62,25 +50,17 @@ Other coins have been known to work with this implementation. I have tested with * Quark * Securecoin -#Installation +# Installation The installation of this *stratum-mining* can be found in the Repo Wiki. -#Contact -I am available in the #MPOS, #crypto-expert, #digitalcoin, and #worldcoin channels on freenode. -Although i am willing to provide support through IRC please file issues on the repo. -Issues as a direct result of stratum will be helped with as much as possible -However issues related to a coin daemon's setup and other non stratum issues, -Please research and attempt to debug first. - - -#Credits +# Credits * Original version by Slush0 and ArtForz (original stratum code) * More Features added by GeneralFault, Wadee Womersley, Viperaus, TheSeven and Moopless * Multi Algo, Vardiff, DB and MPOS support done by Ahmed_Bodi, penner42 and Obigal * Riecoin support implemented by gatra -#License +# License This software is provided AS-IS without any warranties of any kind. Please use at your own risk.