Cleanup html docs using dpatch
[manu/mod-proxy-html.git] / README
diff --git a/README b/README
index 2c2f65d..086a344 100644 (file)
--- a/README
+++ b/README
@@ -3,11 +3,20 @@ DOCUMENTATION for this module is at
 
 UPGRADING: IMPORTANT NOTE
 
-If you are upgrading from mod_proxy_html 2.x (or 1.x), you will need
-some new configuration.  You can Include proxy_html.conf from this
-bundle in your httpd.conf (or apache.conf) to use Version 3 as a
-drop-in replacement for Version 2.
+Upgrading from 3.0 or any earlier version, you may need to:
+  (1) Load mod_xml2enc
+  (2) Use the new "ProxyHTMLEnable On" directive in place of
+      Apache's general-purpose filter configuration (such as
+      SetOutputFilter or FilterChain).
+Without these it'll work fine with ASCII or Unicode utf-8,
+but is likely to display characters incorrectly with other
+character encodings.
 
+If you are upgrading from mod_proxy_html 2.x (or 1.x), you will need
+to configure what HTML elements should be treated as links and events.
+The configuration file "proxy_html.conf" loaded into your httpd.conf
+(or apache.conf, apache2.conf or similar according to packager's whims)
+does this if you're dealing with standard/W3C HTML 4 and/or XHTML 1.
 
 WINDOWS USERS: