Various adjustments

[pstop.git] / README.md

diff --git a/README.md b/README.md
index b895928..3c89531 100644 (file)
--- a/README.md
+++ b/README.md
@@ -2,3 +2,26 @@ pstop
 =====
 
 pstop - a top-like program for MySQL
+
+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, keys.txt which describes the keys used inside pstop, and
+screen_samples.txt which provides some sample output from my own system.
+
+Feedback and patches welcome.
+
+Simon J Mudd
+<sjmudd@pobox.com>