Changeset 45293

Timestamp:

05/11/08 19:30:50 (2 months ago)

Author:

scompt

Message:

Fleshing out readme. Fixing name of screenshot file.

Files:

• immerstat/trunk/readme.txt (modified) (2 diffs)
• immerstat/trunk/screenshot-1.jpg (moved) (moved from immerstat/trunk/screenshot1.jpg)

immerstat/trunk/readme.txt

@@ -11 +11 @@
-== Description ==
-
-The graphic is provided using the Google Charts API
+You must also have the [WordPress.com Stats plugin](http://wordpress.org/extend/plugins/stats/) installed and configured.  The graphic is provided using the [Google Charts API](http://code.google.com/apis/chart/)
-
-It also removes the WordPress.com Stats panel from the dashboard.  If you want to see all the information that WordPress.com Stats provides, you can still go to that subpage.  Your dashboard no longer has any Flash elements on it!
+
+ImmerStat has been tested in WordPress 2.5.  It should work in versions 2.3 and 2.2, but it hasn't been tested there.  Please let [me](mailto:scompt@scompt.com) know if there are any problems.
-
-== Installation ==
@@ -19 +21 @@
-1. Upload the `immerstat` directory to the `/wp-content/plugins/` directory
-1. Activate the plugin through the 'Plugins' menu in WordPress
+
+== Configuration ==
+
+There's no Options/Settings panel for ImmerStat.  Instead, a number of filter hooks are provided to change the default behavior.  Here's what they are.
+
+= immerstat_days =
+
+This is the number of days that should be displayed.  The default value is `30`.
+
+= immerstat_colors =
+
+This is an associative array that represents the colors that will be used for the graph.  It has 3 keys: `bg`, `under`, `line`.  The values are guessed for the current admin color scheme in use.
+
+= immerstat_img_link_args =
+
+This is an associative array of arguments that will be sent to the [Google Charts API](http://code.google.com/apis/chart/).  Check out that link for the various options available.
-
-== Frequently Asked Questions ==