rewrite README.me to explain

This commit is contained in:
YAMAMOTO Takashi 2015-04-22 23:44:13 +09:00
parent 930b109ed1
commit e9a745f35f
4 changed files with 16 additions and 7 deletions

View file

@ -1,3 +1,8 @@
Installation steps should be found on http://www.dugwood.com/clickheat/installation.html
Install it via Piwik Marketplace.
La description de l'installation devrait se trouver sur http://www.dugwood.fr/clickheat/installation.html
This plugin installer will make directories:
yourpiwik/tmp/cache/clickheat/cache
yourpiwik/tmp/cache/clickheat/logs.
This plugin uses a different tracker. Please click on the link "JavaScript" and put the special Javascript codes into your website.

View file

@ -28,11 +28,15 @@ __And what functions are not included in this feature ?__
__Where is the coordinate information from the browser ?__
ClickHeat plugin uses text files to record the coordinate data of each browser in directory: yourpiwik/tmp/cache/clickheat/logs.
ClickHeat plugin uses text files to record the coordinate data of each browser in directory: yourpiwik/tmp/cache/clickheat/logs.
__Does it withstands high traffics ?__
Unfortunately not. Because this plugin uses text files to record data. Therefore, please use this plugin to experiment or low traffics.
This plugin uses minimal text to record data and file based logging. And when click.php is called from a special Javascript for cgi, just append text on end of the each file. And when you analyze the click data and make a heatmap, plugin will create cached heatmap as png image file.
Therefore, we expect the plugin light works, but we don't know what load it has under Piwik 2.x. So we are very glad, when you inform us about your situation.
Please see the link [Performance and optimization](http://www.labsmedia.com/clickheat/156894.html) about system resources. If you want performance, you need to avoid to use a cgi, that is possible. It method is explained on the link.
__New click data were added, but not updated heatmap. Why ?__
@ -40,7 +44,7 @@ Plugin places heatmap images in the cache directory: yourpiwik/tmp/cache/clickhe
__Showed a heatmap, but not overlay a heatmap to the target web page. Why ?__
Check that your website does not set the HTTP header __X-FRAME-OPTIONS__ to __SAMEORIGIN__ as this will prevent this plugin from iframing your website for the heatmap report. Please see [Page Overlay Troubleshooting](http://piwik.org/docs/page-overlay/#page-overlay-troubleshooting), that is same problem.
Check that your website does not set the HTTP header __X-FRAME-OPTIONS__ to __SAMEORIGIN__ as this will prevent this plugin from iframing your website for the heatmap report. Please see [Page Overlay Troubleshooting](http://piwik.org/docs/page-overlay/#page-overlay-troubleshooting), that is same problem.
## Changelog
* 0.1.0 First beta

View file

@ -5,7 +5,7 @@
"theme": false,
"keywords": ["clickheat", "heatmap", "dugwood", "piwikjapan", "yamachan"],
"require": {
"piwik": ">=2.12.1"
"piwik": ">=2.11.1"
},
"license": "GPLv3 or later",
"authors": [
@ -15,7 +15,7 @@
"homepage": "http://www.dugwood.com/clickheat/index.html"
},
{
"name": "yamachan(a member of PiwikJapan)",
"name": "yamachan (a member of PiwikJapan)",
"email": "yamachan@piwikjapan.org",
"homepage": "http://www.piwikjapan.org/"
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 181 KiB