Add "Contributing" section to README

[pstop.git] / README.md

diff --git a/README.md b/README.md
index 9985f22..d1a22f2 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,11 +10,6 @@ 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
 
 Install and update this go package with `go get -u github.com/sjmudd/pstop`
@@ -22,23 +17,25 @@ Install and update this go package with `go get -u github.com/sjmudd/pstop`
 ### Configuration
 
 Access to MySQL is currently via a defaults-file which is assumed
-to be ~/.my.cnf. This should probably be made more configurable.
+to be `~/.my.cnf`. This should probably be made more configurable.
 If you see a need for this please let me know.
 
 ### Grants
 
-Do not forget to ensure that the MySQL user you configure has access
-to the performance_schema tables.
+`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:
+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.
@@ -55,9 +52,25 @@ The following keys allow you to navigate around the different pstop displays or
 
 ### See also
 
-See also BUGS and NEW_FEATURES which describe things that probably
-need looking at and screen_samples.txt which provides some sample
-output from my own system.
+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