Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

README has been reformatted to RST.

  • Loading branch information...
commit 409e5cc16df3be09dd44c3d0e0d09e5c08cef123 1 parent 6f74b5b
@wmark wmark authored
Showing with 104 additions and 114 deletions.
  1. +1 −0  .gitignore
  2. +103 −0 README.rst
  3. +0 −114 readme.txt
View
1  .gitignore
@@ -1,2 +1,3 @@
*.komodoproject
.komodotools
+README.pdf
View
103 README.rst
@@ -0,0 +1,103 @@
+====================================
+CDN Linker - Wordpress Plugin
+====================================
+:Info: See `github <http://github.com/wmark/CDN-Linker>`_ for the latest source.
+:Author: W-Mark Kubacki <wmark@hurrikane.de>
+:Tags: CDN,links,cloudfront,simplecdn,media,performance,distribution,accelerator,content,speed,cloud
+:Requires at least: 2.7
+:Tested up to: 3.1.2
+
+Rewrites links to static files to your own CDN network.
+
+Description
+============
+Replaces the blog URL by another for all files under `wp-content` and `wp-includes`.
+That way static content can be handled by a CDN by origin pull. (The origin is your blog address.)
+
+You could upload your static files to S3, CloudFront or just any site, too.
+For S3/Cloudfront, see this script_ to help you with uploading/synchronizing your blog files.
+
+The **lite version** of the plugin works like the **regular version** but is not supported.
+You can get the *regular version* at Github_ which:
+
+* Is free of charge, open source and without any ads.
+* Supported. Here is `the bug tracker`__ if you encounter any issues.
+* Has more and advanced features.
+* Is updated more frequently. See downloads_.
+* Quality assurance.
+
+.. _script: http://mark.ossdl.de/2009/09/how-to-copy-your-wordpress-files-to-cloudfront-efficiently/
+.. _Github: http://github.com/wmark/CDN-Linker
+.. _issues: http://github.com/wmark/CDN-Linker/issues
+.. _downloads: http://github.com/wmark/CDN-Linker/downloads
+__ issues_
+
+License
+========
+Licensed under the Reciprocal Public License, Version 1.5, for non-commercial
+(http://www.opensource.org/licenses/rpl1.5).
+
+Installation
+=============
+
+1. Setup your CDN: Either configure an origin pull, mirror bucket or upload your static files somewhere.
+2. Upload the plugin to your `/wp-content/plugins/` directory.
+3. Activate the plugin through the 'Plugins' menu in WordPress.
+4. Provide the URL, where your static files can be found, under `Settings`.
+
+Frequently Asked Questions
+===========================
+
+How to uninstall?
+ Either deactivate the plugin or delete the plugin's directory.
+
+Why another such plugin?
+ As many WP plugins don't correctly include JS and CSS files most of the current CDN plugins cannot
+ rewrite links correctly. They rely on the high-level WP API.
+
+ This plugin does its rewriting on the lowest level possible - PHP itself.
+
+How does it work?
+ After your blog pages have been rendered but before sending them to the visitor,
+ it will rewrite links pointing to `wp-content` and `wp-includes`. That rewriting will simply
+ replace your blog URL with that you have entered in settings screen.
+
+ Thus files are pulled from the other site.
+
+Is it compatible to plugin XY?
+ Yes, by design it is compatible to all plugins. It hooks into a PHP function ob_start_
+ and there does the string replacement. Therefore, no Wordpress function is altered, overwritten or modified in any way.
+
+ Indeed, you could even copy this plugin's rewriter into any arbitrary PHP software.
+
+Where can I see it in action?
+ On my own blog, `Mark's blog`__. See the source code of any page.
+
+Will it work with my CDN?
+ Yes, **if it supports origin pull** (aka mirror bucket, some sort of caching). Or if you upload your files manually.
+
+What about Amazon's S3?
+ Right, S3 doesn't support origin pull. You will have to upload your files by hand.
+ I've written a script for this, too, so it is just a matter of running it. It is linked on the bottom of my blog post about
+ `copying files to S3 <http://mark.ossdl.de/2009/09/how-to-copy-your-wordpress-files-to-cloudfront-efficiently/>`_.
+
+What other plugins do you recommend?
+ Now that you can offload all the files such as images, music or CSS, you should serve your blog posts as static files to
+ decrease load on your server. I recommend SuperCache-Plus_ as it will maintain, update and create that static files from
+ dynamic content for you. The off-linker is compatible.
+
+Alternatives?
+ The experts at `Arcostream` currently develop (or have it ready by now) a plugin which enables you to set up a CDN at their's
+ with one click or two. Without any configuration, everything is automatic. Please google their licensed flavour of this plugin. ;-)
+
+I discovered a bug!
+ If you are using the `lite` version, please upgrade.
+ The following applies only to the `regular` version which you can find at Github_:
+
+ Share it with me! The rarer a species, the more interesting. But I will need its habitat, too.
+ Therefore, please send me at least one page with the plugin turned off and on, as attachment.
+
+.. _ob_start: http://us2.php.net/manual/en/function.ob-start.php
+.. _Mark: http://mark.ossdl.de/
+.. _SuperCache-Plus: http://murmatrons.armadillo.homeip.net/features/experimental-eaccelerator-wp-super-cache
+__ Mark_
View
114 readme.txt
@@ -1,114 +0,0 @@
-=== Plugin Name ===
-Contributors: wmark
-Tags: CDN,links,cloudfront,simplecdn,media,performance,distribution,accelerator,content,speed,cloud
-Requires at least: 2.7
-Tested up to: 3.1.2
-Stable tag: 1.3.1
-
-Rewrites links to static files to your own CDN network.
-
-== Description ==
-
-Replaces the blog URL by another for all files under `wp-content` and `wp-includes`.
-That way static content can be handled by a CDN by origin pull. (The origin is your blog address.)
-
-You could upload your static files to S3, CloudFront or just any site, too.
-For S3/Cloudfront, see [this script](http://mark.ossdl.de/2009/09/how-to-copy-your-wordpress-files-to-cloudfront-efficiently/ "how to copy your Wordpress files to CloudFront efficiently")
-to help you with uploading/synchronizing your blog files.
-
-== Installation ==
-
-1. Setup your CDN: Either configure an origin pull, mirror bucket or upload your static files somewhere.
-2. Upload the plugin to your `/wp-content/plugins/` directory.
-3. Activate the plugin through the 'Plugins' menu in WordPress.
-4. Provide the URL, where your static files can be found, under `Settings`.
-
-== Frequently Asked Questions ==
-
-= How to uninstall? =
-
-Either deactivate the plugin or delete the plugin's directory.
-
-= Why another such plugin? =
-
-As many WP plugins don't correctly include JS and CSS files most of the current CDN plugins cannot
-rewrite links correctly. They rely on the high-level WP API.
-
-This plugin does its rewriting on the lowest level possible - PHP itself.
-
-= How does it work? =
-
-After your blog pages have been rendered but before sending them to the visitor,
-it will rewrite links pointing to `wp-content` and `wp-includes`. That rewriting will simply
-replace your blog URL with that you have entered in settings screen.
-
-Thus files are pulled from the other site.
-
-= Is it compatible to plugin XY? =
-
-Yes, by design it is compatible to all plugins. It hooks into a PHP function ([ob_start](http://us2.php.net/manual/en/function.ob-start.php "function documentation"))
-and there does the string replacement. Therefore, no Wordpress function is altered, overwritten or modified in any way.
-
-Indeed, you could even copy this plugin's rewriter into any arbitrary PHP software.
-
-= Where can I see it in action? =
-
-On my own blog, [Mark's blog](http://mark.ossdl.de/ "Mark's blog"). See the source code of any page.
-
-= Will it work with my CDN? =
-
-Yes, if it supports origin pull (aka mirror bucket, some sort of caching). Or if you upload your files manually.
-
-= What about Amazon's S3? =
-
-Right, S3 doesn't support origin pull. You will have to upload your files by hand.
-I've written a script for this, too, so it is just a matter of running it. It is linked on the bottom of my blog post about [copying files to S3](http://mark.ossdl.de/2009/09/how-to-copy-your-wordpress-files-to-cloudfront-efficiently/ "how to copy your Wordpress files to S3 efficiently").
-
-= What other plugins do you recommend? =
-
-Now that you can offload all the files such as images, music or CSS, you should serve your blog posts as static files to decrease load on your server.
-I recommend [SuperCache-Plus](http://murmatrons.armadillo.homeip.net/features/experimental-eaccelerator-wp-super-cache "Wordpress SuperCache-Plus")
-as it will maintain, update and create that static files from dynamic content for you.
-The off-linker is compatible.
-
-= Alternatives? =
-
-The experts at `Arcostream` currently develop (or have it ready by now) a plugin which enables you to set up a CDN at their's
-with one click or two. Without any configuration, everything is automatic. Please google their licensed flavour of this plugin. ;-)
-
-= I discovered a bug! =
-
-Share it with me! The rarer a species, the more interesting. But I will need its habitat, too.
-Therefore, please send me at least one page with the plugin turned off and on, as attachment.
-
-== Changelog ==
-
-= 1.3.1 =
-* fixed: bug which has always enabled the feature "root-relative links"
-
-= 1.3.0 =
-* Support for multiple CDN (domain) names. (Idea by "ericesev" and "digory". You're great!)
-* New option to rewrite "root-relative" links has been added. (As suggested by Tony Stuck. Thanks!)
-* The plugin has been rewritten and received unit tests.
-
-The plugin has been
-* renamed to "CDN Linker" and
-* moved to [Github](https://github.com/wmark/CDN-Linker).
-
-= 1.1.1 =
-* version bump due to Wordpress' plugin page having released the plugin prematurely
-
-= 1.1.0 =
-* an input field has been added for defining matches that shall be excluded from rewriting
-* added the feature to include additional (to `wp-content` and `wp-includes`) directories for rewriting
-* fixed: bug which messed with urls located at the root level of the site, introduced in 1.0.2 (thanks to Vic Holtreman for reporting)
-
-= 1.0.2 =
-* rewriting of URLs from embedded `style=xy:url(...)` CSS attributes
-* fixed: wrongful rewrite of links into the blogs root directory (thanks to Greg Winn for reporting)
-
-= 1.0.1 =
-* support for off-loading files in root directory, such as `favicon.ico` or `apple-touch-icon.png`
-
-= 1.0 =
-* initial version, as published on my blog

0 comments on commit 409e5cc

Please sign in to comment.
Something went wrong with that request. Please try again.