adding comments and readme.txt for example

mhenke · Jan 1, 2010 · 5325935 · 5325935
1 parent fe7a3b9
commit 5325935
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 1 deletion.
diff --git a/example/index.cfm b/example/index.cfm
@@ -1,3 +1,8 @@
+<!--- see readme.txt for testing this example file --->
+
+<!--- component path to jtidy.cfc --->
+<cfset componentPath = "jtidy_cfc.jtidy" />
+
 <cfsavecontent variable="test">
 <html>
 	<head>
@@ -47,7 +52,7 @@
 </cfsavecontent>
 
 <cfinvoke 
- component="jtidy_cfc.jtidy" 
+ component="#componentPath#" 
     method="makexHTMLValid" 
 	strToParse="#test#"
     returnvariable="validxHTML"

diff --git a/example/readme.txt b/example/readme.txt
@@ -0,0 +1,3 @@
+1) place index.cfm somewhere under your webroot
+2) replace the componentPath with the jtidy.cfc path
+3) run the page, you should have valid XHTML