updated docs for new format

matomo-org · Sep 7, 2016 · 225330d · 225330d
1 parent 0f513db
commit 225330d
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 46 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+## Changelog
+
+* 0.2.0 Compatibility w/ Piwik 2.15.
+* 0.1.1 Fix for IE8
+* 0.1.0 Initial Release
diff --git a/README.md b/README.md
@@ -5,49 +5,3 @@
 ## Description
 
 View log messages that were logged by Piwik via the Piwik UI or HTTP Reporting API.
-
-## FAQ
-
-__I want to see more than 100 log messages, is it possible?__
-
-Yes, there is a `limit` URL parameter that you can change to any number.
-
-__Can I use regular expressions in the search field?__
-
-Yes, you can enable regular expressions next to the search field.
-
-__Is the search field case insensitive?__
-
-Yes.
-
-__How is a Piwik log line formatted by default?__
-
-`'$severity $tag[$datetime] [$requestId] $message` eg `WARNING Piwik\Common[2015-01-01 01:02:03] [cf27] The log message`
-
-__Is the search pattern applied to the whole log line?__
-
-Yes, this means a search for `WARNING Piwik\Common` would deliver you all warnings triggered by `Piwik\Common`.
-
-__How do I find all messages that belong to a certain request?__
-
-Each log message shows a "Request Id". By clicking on this Id it selects all log messages of the same request.
-Alternatively you can search for the expression `\[1234\]` where `1234` need to be replaced by a Request Id.
-
-__How do I find messages that belong to the same day?__
-
-Either click on a date field or search for it, eg `2012-12-12`.
-
-__What are the known issues?__
-
-* If there are messages being logged while viewing the log messages, the paging might not work 100% correctly.
-* There seems to be a problem when searching for a single quotation mark "'".
-
-## Changelog
-
-* 0.2.0 Compatibility w/ Piwik 2.15.
-* 0.1.1 Fix for IE8
-* 0.1.0 Initial Release
-
-## Support
-
-Please direct any feedback to [hello@piwik.org](mailto:hello@piwik.org)
diff --git a/docs/faq.md b/docs/faq.md
@@ -0,0 +1,35 @@
+## FAQ
+
+__I want to see more than 100 log messages, is it possible?__
+
+Yes, there is a `limit` URL parameter that you can change to any number.
+
+__Can I use regular expressions in the search field?__
+
+Yes, you can enable regular expressions next to the search field.
+
+__Is the search field case insensitive?__
+
+Yes.
+
+__How is a Piwik log line formatted by default?__
+
+`'$severity $tag[$datetime] [$requestId] $message` eg `WARNING Piwik\Common[2015-01-01 01:02:03] [cf27] The log message`
+
+__Is the search pattern applied to the whole log line?__
+
+Yes, this means a search for `WARNING Piwik\Common` would deliver you all warnings triggered by `Piwik\Common`.
+
+__How do I find all messages that belong to a certain request?__
+
+Each log message shows a "Request Id". By clicking on this Id it selects all log messages of the same request.
+Alternatively you can search for the expression `\[1234\]` where `1234` need to be replaced by a Request Id.
+
+__How do I find messages that belong to the same day?__
+
+Either click on a date field or search for it, eg `2012-12-12`.
+
+__What are the known issues?__
+
+* If there are messages being logged while viewing the log messages, the paging might not work 100% correctly.
+* There seems to be a problem when searching for a single quotation mark "'".
diff --git a/plugin.json b/plugin.json
@@ -9,6 +9,11 @@
   "require": {
     "piwik": ">=3.0.0-dev,<4.0.0-dev"
   },
+  "support": {
+    "issues": "https://github.com/piwik/plugin-LogViewer/issues",
+    "forum": "https://forum.piwik.org",
+    "source": "https://github.com/piwik/plugin-LogViewer"
+  },
   "authors": [
     {
       "name":  "Piwik",