From: Simon J Mudd Date: Tue, 11 Nov 2014 21:43:00 +0000 (+0100) Subject: Adjust README.md X-Git-Url: http://git.iain.cx/?p=pstop.git;a=commitdiff_plain;h=c24180cda0bbab4ae07c87bf2cdf54e61d358142 Adjust README.md --- diff --git a/README.md b/README.md index c4bc21f..76d8d0d 100644 --- a/README.md +++ b/README.md @@ -3,4 +3,24 @@ pstop pstop - a top-like program for MySQL -More information to follow shortly. +pstop is a program which collects information from MySQL 5.6+'s +performance_schema database and uses this information to display server +load in real-time. This should also work for MariaDB 10.0 though I +have not tested this at all. Data is shown by table or filename and the +metrics also show how this is split between select, insert, update or +delete activity. + +This program was started as a simple project to allow me to learn go, +which I'd been following for a while, but hadn't used in earnest. This +probably shows in the code so suggestions on improvement are most welcome. + +Access to MySQL is currently via a defaults-file which is assumed to be +~/.my.cnf. I should probably make this more configurable. + +See also BUGS and NEW_FEATURES which describe things that probably need +looking at. + +Feedback and patches welcome. + +Simon J Mudd +