Permalink
Browse files

refining some of the README

  • Loading branch information...
Matt Richmond
Matt Richmond committed Oct 25, 2012
1 parent c217cde commit 0570d8be0920b2be50126db9c340687361b4e549
Showing with 8 additions and 5 deletions.
  1. +8 −5 README.txt
View
@@ -7,12 +7,12 @@
## Installation
- Install the plugin in the WordPress plugins directory
-- Create a cfao-cache directory in wp-content. This directory must be writable by the web user.
+- Create a cfao-cache directory in wp-content. **This directory must be writable by the web user.**
- Ensure that the web server is capable of sending a request to itself and getting a successful response.
## Configuration
-- Hit the homepage. This will cause the plugin to get a list of all styles/scripts used on this page.
-- Hit other pages as well, if they are expected to use scripts that would not be included on the home page.
+- Navigate to the homepage. This will cause the plugin to get a list of all styles/scripts used on this page.
+- Navigate to other pages as well if they are expected to use scripts that would not be included on the home page.
- Go into the website admin section, and go to the CF Asset Optimizer settings page.
- *The steps below are the only steps guaranteed to work in all cases. They are not the ideal steps, and each site must be tuned manually for best performance.*
- Check the caching solution checkbox if the site is using a caching solution.
@@ -28,15 +28,18 @@
- If the site is not using a caching solution:
- After the page loads, refresh. The concatenation is handled asynchronously in these cases, so it won't have been done for this request.
- View the page source. In the header, the scripts and styles should be concatenated. If the concatenation does not match what is expected, review settings.
+ - You can tell if they're contactenated if they've become requests to something similar to the following:
+
+ `/wp-content/cfao-cache/[domain_here]/css/0f3bb05f176c9605990f8004949108f2.css?ver=1351111600`
## Maintenance
- If a script or stylesheet is added or changed, it will not be included in the concatenated files served.
- - *Note: Scripts dependent on a script that is not included will also not be included to prevent circular dependency failures.*
+ - **Note: Scripts dependent on a script that is not included will also not be included to prevent circular dependency failures.**
- If a script or stylesheet is not included in the concatenated file, and needs to be:
- Go into the admin settings for the Asset Optimizer
- Enable the desired scripts and stylesheets that are currently disabled and save those settings.
- Clear the CSS and JS caches to force the server to rebuild the concatenated files.
- Request the homepage.
- Refresh once if you're not using a caching solution, to ensure that you can review the concatenation as completed.
- Review the page source, ensure that the scripts and stylesheets are concatenated as expected.
-- *Note: Concatenated static filenames do not change unless the enqueued script/stylesheet handle for one of the concatenated files changes, or a file is added.*
+- **Note: Concatenated static filenames do not change unless the enqueued script/stylesheet handle (i.e., not the content of those scripts) for one of the concatenated files changes, or a file is added.**

0 comments on commit 0570d8b

Please sign in to comment.