From 4a88e5ae0475198e44ea13d9849465544c9b1fea Mon Sep 17 00:00:00 2001
From: Guust Nieuwenhuis <guust@orangelark.be>
Date: Mon, 21 Apr 2014 22:18:04 +0200
Subject: [PATCH] improved documentation

---
 README.md                            | 44 ++++++++++++++++++++++++--
 admin/views/instructions/default.cfm | 46 ++++++++++++++++++++++++----
 2 files changed, 82 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 1c5afa7..24093d8 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,44 @@
-MuraPiwik
-=========
+MuraPiwik v0.1
+==============
 
 Mura CMS plugin for Piwik integration.
+
+
+Features
+--------
+
+* Automatically Insert Tracking Code
+	* JavaScript Tracking
+	* JavaScript Tracking with image fallback
+	* Image Tracking
+	* HTTP Tracking
+* Admin Settings
+	* Per site configuration
+* Piwik Dashboard
+	* View your Piwik Dashboard within Mura CMS
+
+
+Installation
+------------
+
+Install the plugin by uploading a zip or by providing the url.
+
+
+Configuration
+-------------
+
+When installing the plugin, provide the url for your Piwik instance.
+
+Once the plugin is installed, further configuration is available within the site settings. On the "Extended Attributes"-tab you'll be able to set the Piwik siteId to be used and the method of Tracking.
+
+Every Mura User can set his/her Piwik authentication code. Configuring this will allow the dashboad to be loaded even when the user is not loggedin to Piwik.
+
+
+Roadmap
+-------
+
+Version 0.2
+* All tracking options
+
+Version 0.3
+* Piwik widgets in the Mura Dashboard
\ No newline at end of file
diff --git a/admin/views/instructions/default.cfm b/admin/views/instructions/default.cfm
index fae0694..d16fd1f 100644
--- a/admin/views/instructions/default.cfm
+++ b/admin/views/instructions/default.cfm
@@ -10,10 +10,44 @@ http://www.apache.org/licenses/LICENSE-2.0
 --->
 </cfsilent>
 <cfoutput>
-	<h2>Plugin Configuration Instructions</h2>
-	<p>Within the plugin settings you're able to set url of Piwik.</p>
-	<h2>Site Configuration Instructions</h2>
-	<p>In the settings of a site you're able to configure site specific settings like the Piwik siteId and the method of tracking used.</p>
-	<h2>User Configuration Instructions</h2>
-	<p>Every user can set his/her Piwik authentication code. Once this code is set, the dashboard will automaticly load even when the user is not logged into Piwik.</p>
+
+	<h1>MuraPiwik v0.1</h1>
+	<p>Mura CMS plugin for Piwik integration.</p>
+
+	<h2>Features</h2>
+	<ul>
+		<li>Automatically Insert Tracking Code</li>
+		<ul>
+			<li>JavaScript Tracking</li>
+			<li>JavaScript Tracking with image fallback</li>
+			<li>Image Tracking</li>
+			<li>HTTP Tracking</li>
+		</ul>
+		<li>Admin Settings
+		<ul>
+			<li>Per site configuration</li>
+		</ul>
+		<li>Piwik Dashboard</li>
+		<ul>
+			<li>View your Piwik Dashboard within Mura CMS</li>
+		</ul>
+	</ul>
+
+	<h2>Installation</h2>
+	<p>Install the plugin by uploading a zip or by providing the url.</p>
+
+	<h2>Configuration</h2>
+	<p>When installing the plugin, provide the url for your Piwik instance.</p>
+	<p>Once the plugin is installed, further configuration is available within the site settings. On the "Extended Attributes"-tab you'll be able to set the Piwik siteId to be used and the method of Tracking.</p>
+	<p>Every Mura User can set his/her Piwik authentication code. Configuring this will allow the dashboad to be loaded even when the user is not loggedin to Piwik.</p>
+
+	<h2>Roadmap</h2>
+	<h3>Version 0.2</h3>
+	<ul>
+		<li>All tracking options</li>
+	</ul>
+	<h3>Version 0.3</h3>
+	<ul>
+		<li>Piwik widgets in the Mura Dashboard</li>
+	</ul>
 </cfoutput>
\ No newline at end of file