Update README.md

This commit is contained in:
Sebastian Grewe 2013-05-21 15:42:44 +03:00
parent 0aab1dff9a
commit fb56bde2e4

View File

@ -3,7 +3,7 @@ Description
mmcFE-ng is a web frontend for Pooled LTC Mining. mmcFE-ng is a web frontend for Pooled LTC Mining.
This is based on mmcFE, the original work by Greedi: The web frontend layout is based on mmcFE, the original work by Greedi:
https://github.com/Greedi/mmcFE https://github.com/Greedi/mmcFE
After working a few days trying to learn to run my own pool and the After working a few days trying to learn to run my own pool and the
@ -12,6 +12,10 @@ understand how it works. While doing so I also migrated the existing
code over to my own framework so maintenance would be easier in the code over to my own framework so maintenance would be easier in the
future. future.
**NOTE**: This project is still under development and commits are happening on a daily basis.
I do not recommend using this for a live setup as of yet. Wait for the later Release Candidate
if you wish to run your pool with it. Testing pools are much appreciated though!
Requirements Requirements
============ ============
@ -31,6 +35,24 @@ in the appropriate forums.
* pushpoold * pushpoold
* litecoind * litecoind
Features
========
The following feature have been implemented so far:
* Use of memcache for statistics instead of a cronjob
* Web User accounts
* Worker accounts
* Worker activity (live, past 10 minutes)
* Worker hashrates (live, past 10 minutes)
* Pool statistics
* Minimal Block statistics
* Pool donations
* Pool fees
* Manual payout with 0.1 LTC fee
* Auto payout with 0.1 LTC fee
* Transaction list (confirmed and unconfirmed)
Installation Installation
============ ============
@ -124,8 +146,9 @@ me know by creating an [Issue][1] marked as `Feature Request`.
Disclaimer Disclaimer
========== ==========
This is a *WIP Project*. Most functionality is now added, the core This is a **WIP Project**. Most functionality is now added, the core
features are available and the backend cronjobs are working. If you features are available and the backend cronjobs are working. I would not recommend
encounter any problems related to the code please create a new [Issue][1] running this on a live pool yet. You can play around and test basic functionality but
wait for any live deployment for at least a stable Release Candidate.
[1]: https://github.com/TheSerapher/php-mmcfe-ng/issues "Issue" [1]: https://github.com/TheSerapher/php-mmcfe-ng/issues "Issue"