[gnome-online-miners/sam/help-and-debug: 1/4] README: Add some stub documentation on how to use the miners

[Sam Thursfield <sthursfield src gnome org>]

commit 9684b77d1d852e6c42e7322f26d6ce280809fbdc
Author: Sam Thursfield <ssssam gmail com>
Date:   Sun Sep 4 01:15:07 2016 +0100

    README: Add some stub documentation on how to use the miners

 README |   19 ++++++++++++++++++-
 1 files changed, 18 insertions(+), 1 deletions(-)
---
diff --git a/README b/README
index c3a8252..9ec58a8 100644
--- a/README
+++ b/README
@@ -6,7 +6,24 @@ Download: http://download.gnome.org/sources/gnome-online-miners
 Git: http://git.gnome.org/browse/gnome-online-miners
 Website: https://wiki.gnome.org/Projects/GnomeOnlineMiners
 
-----
+How to Use
+----------
+
+GNOME Online Miners is a "middleware" component: it's expected to be useful
+to developers making applications, rather than being used by desktop users
+directly.
+
+The miners do not run in the background continuously. Instead, applications
+interested in remote content need to use D-Bus to call the
+org.gnome.OnlineMiners.Miner.RefreshDB method. You should call this regularly
+while the application is running, in order to keep in sync with server-side
+changes.
+
+See the GNOME Documents and GNOME Photos applications for further examples of
+how to use these miners.
+
+License
+-------
 
 GNOME Online Miners is licensed under the GNU General Public License as
 published by the Free Software Foundation, either version 2 of the License,