aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorThibaut Horel <thibaut.horel@gmail.com>2014-07-14 17:39:32 -0400
committerThibaut Horel <thibaut.horel@gmail.com>2014-07-14 17:39:32 -0400
commitdd5bee919c00a372679858f9ba10e4caf6170fb1 (patch)
treeec23a24a744af64fbeec51a16d162b1e1f0a60b2 /README.rst
parentfd0b905876bac80335dcb10a9749c520f1b588ff (diff)
downloadbrowsing-activity-tracker-dd5bee919c00a372679858f9ba10e4caf6170fb1.tar.gz
Minor corrections to README
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 23 insertions, 14 deletions
diff --git a/README.rst b/README.rst
index 3c7e735..e87ad9b 100644
--- a/README.rst
+++ b/README.rst
@@ -22,39 +22,41 @@ How does it work?
The extension notifies a callback URL by sending an HTTP POST request whenever
one the following events occur:
-* the browser window is activated (gains focus)
+* a browser window is activated (gains focus)
* a tab is activated
-* a webpage is loaded
-* the browser window is deactivated (loses focus)
+* a webpage is loaded (when you follow a link, or navigate through your
+ history)
+* a browser window is deactivated (loses focus)
-The content of the POST request is a JSON object containing the following keys:
+The body of the POST request is a JSON object containing the following keys:
========= ===========
Key Name Description
========= ===========
``title`` Title of the webpage (typically the content of the ``<title>`` tag)
``url`` URL of the webpage
-``time`` Time at which the event occured. Number of milliseconds elapsed since 1 January 1970 00:00:00 UTC
+``time`` Time at which the event occurred. Number of milliseconds elapsed
+ since 1 January 1970 00:00:00 UTC
``key`` A key identifying the browser sending the request
========= ===========
-For window activation events, all the keys except for the ``time`` key are set
-to ``null``.
+For window deactivation events, all the keys except for the ``time`` key are
+set to ``null``.
Example of request content:
.. code:: json
- {"url":"http://getbootstrap.com/css/",
- "time":1405240158749,
- "title":"CSS · Bootstrap",
+ {"url":"https://github.com/Thibauth/browsing-activity-tracker",
+ "time":1405354714678,
+ "title":"Thibauth/browsing-activity-tracker",
"key":"firefox"}
Also note that the window activation and deactivation events are triggered by
-your window manager and vary depending on your operating system and window
-manager. For example, in window managers based on X11, a deactivation event is
-always triggered before an activation event.
+your window manager and vary depending on your configuration. For example, in
+window managers based on X11, a deactivation event is always triggered before
+an activation event.
Configuration
+++++++++++++
@@ -62,4 +64,11 @@ Configuration
The browser key and the callback URL can be customized in the extension
preferences. The key is useful in settings where you are logging events from
several browsers at the same time as well as to provide some (very limited)
-authentication.
+authentication. The default settings are:
+
+============ ===========
+Option Default Value
+============ ===========
+callback URL ``http://localhost:8080``
+Browser Key ``firefox`` for Firefox, ``chrome`` for Chrome
+============ ===========