X-Git-Url: http://git.iain.cx/?a=blobdiff_plain;f=README.md;h=d1a22f2a6c67fc552c5ea91d1793cf7a4766367e;hb=724089cf7925d3e7f54f4b9cf7be341d6fdbe8bf;hp=3c89531ddcf7700e19df63a118b149606e372f86;hpb=529c4f067beebdfb751c4f8e8555435f8708ecbc;p=pstop.git

diff --git a/README.md b/README.md
index 3c89531..d1a22f2 100644
--- a/README.md
+++ b/README.md
@@ -1,27 +1,83 @@
-pstop
-=====
+## 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.
+performance_schema database and uses this information to display
+server load in real-time. Data is shown by table or filename and
+the metrics also show how this is split between select, insert,
+update or delete activity.  User activity is now shown showing the
+number of different hosts that connect with the same username and
+the actiity of those users.
 
-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.
+### Installation
 
-Access to MySQL is currently via a defaults-file which is assumed to be
-~/.my.cnf. I should probably make this more configurable.
+Install and update this go package with `go get -u github.com/sjmudd/pstop`
 
-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.
+### Configuration
+
+Access to MySQL is currently via a defaults-file which is assumed
+to be `~/.my.cnf`. This should probably be made more configurable.
+If you see a need for this please let me know.
+
+### Grants
+
+`pstop` needs `SELECT` access to `performance_schema` tables. It
+will not run if access to the required tables is not available.
+
+### Screens
+
+pstop has 5 different screens which get updated by default every second.
+* Latency mode: order table activity by the time waiting to perform operations on them.
+* Ops (operations) mode: order table activity by the number of operations MySQL performs on them.
+* I/O mode: show where MySQL is spending it's time in file I/O.
+* Locks mode: show order based on table locks
+* User mode: show ordering based on how long users are running queries, or the number of connections they have to MySQL.
+
+You can change the polling interval and switch between modes (see below).
+
+### Keys
+
+The following keys allow you to navigate around the different pstop displays or to change it's behaviour.
+
+* h - gives you a help screen.
+* - - reduce the poll interval by 1 second (minimum 1 second)
+* + - increase the poll interval by 1 second
+* q - quit
+* t - toggle between showing the statistics since resetting pstop started or you explicitly reset them (with 'z') [REL] or showing the statistics as collected from MySQL [ABS].
+* z - reset statistics. That is counters you see are relative to when you "reset" statistics.
+* <tab> - change display modes between: latency, ops, file I/O, lock modes and user modes.
+* left arrow - change to previous screen
+* right arrow - change to next screen
+
+### See also
+
+See also:
+* [BUGS](https://github.com/sjmudd/pstop/blob/master/BUGS) currently known issues
+* [NEW_FEATURES](https://github.com/sjmudd/pstop/blob/master/NEW_FEATURES) which describe things that probably need looking at
+* [screen_samples.txt](https://github.com/sjmudd/pstop/blob/master/screen_samples.txt) provides some sample output from my own system.
+
+### Contributing
+
+This program was started as a simple project to allow me (Simon) 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.
+
+You may find "Contributing to Open Source Git Repositories in Go"
+by Katrina Owen to be useful:
+https://blog.splice.com/contributing-open-source-git-repositories-go/
+
+### Licensing
+
+BSD 2-Clause License
+
+### Feedback
 
 Feedback and patches welcome.
 
 Simon J Mudd
 <sjmudd@pobox.com>
+
+### Code Documenton
+[godoc.org/github.com/sjmudd/pstop](http://godoc.org/github.com/sjmudd/pstop)