forked from humanmade/WPThumb
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme to follow new HM format
@joehoyle I copied this format from https://github.com/humanmade/Mercator because it's rad
- Loading branch information
Showing
1 changed file
with
34 additions
and
73 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,81 +1,42 @@ | ||
| === WPThumb === | ||
|
|
||
| Contributors: humanmade, joehoyle, mattheu, tcrsavage, willmot | ||
| Tags: image, resize, thumbnail, crop, phpthumb | ||
| Requires at least: 3.5 | ||
| Tested up to: 3.5.1 | ||
| Stable tag: 0.10 | ||
|
|
||
| An on-demand image generation replacement for WordPress' image resizing. | ||
|
|
||
| == Description == | ||
|
|
||
| WP Thumb is a simple plugin that seamlessly intergrates with the WordPress image functions. You can specify height, width and crop values, and an image will be generated, which is then cached for future use. | ||
|
|
||
| = Features = | ||
|
|
||
| * Automatic images resizing, cropping and caching. | ||
| <table width="100%"> | ||
| <tr> | ||
| <td align="left" width="70"> | ||
| <strong>WP Thumb</strong><br /> | ||
| An on-demand image generation replacement for WordPress' image resizing. | ||
| </td> | ||
| <td align="right" width="20%"> | ||
| <a href="https://travis-ci.org/humanmade/WPThumb"> | ||
| <img src="https://api.travis-ci.org/humanmade/WPThumb.svg?branch=master" alt="Build status"> | ||
| </a> | ||
| </td> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| A <strong><a href="https://hmn.md/">Human Made</a></strong> project. Maintained by @joehoyle. | ||
| </td> | ||
| <td align="center"> | ||
| <img src="https://hmn.md/content/themes/hmnmd/assets/images/hm-logo.svg" width="100" /> | ||
| </td> | ||
| </tr> | ||
| </table> | ||
|
|
||
| WP Thumb is a simple but powerful plugin that seamlessly intergrates with the Core WordPress image handling. You specify height, width and crop values and an image will be generated and cached for future use. | ||
|
|
||
| * Automatic dynamic images resizing, cropping and caching. | ||
| * Ideal for when you want to change the dimensions of default image sizes. | ||
| * Can extend using filters to make use of any of the phpThumb Library functions by manipulating the image object. | ||
| * Integrate with Imgix & S3 via the [WP Thumb Bridge](https://github.com/humanmade/wpthumb-bridge) | ||
|
|
||
| == Changelog == | ||
|
|
||
| #### 0.10 | ||
|
|
||
| * `wpthumb` shortcode | ||
| * bugfixes + tests | ||
|
|
||
| #### 0.9 | ||
|
|
||
| * Removed dependancy on PHP Thumb GD Library, much smaller now! | ||
| * Use the new WordPress 3.5 Image classes | ||
| * Will now use Image Magick if available (though not for watermarking and background_fill currently) | ||
|
|
||
| #### 0.8 | ||
|
|
||
| * Don't activate on less than PHP 5.2.4 | ||
|
|
||
| #### 0.7 | ||
|
|
||
| * Fix some issues with resizing gifs | ||
| * Unit tests for cropping gifs | ||
| * Improved code formatting and commenting | ||
| * Pipe `STDERR` to `dev/null` in phpthumb `exec` so that error_log isn't polluted with checks for ImageMagick | ||
| * Fix some readme layout issues | ||
| * Don't resize if image is already correct dimensions, + unit test | ||
|
|
||
| #### 0.5 | ||
|
|
||
| * Added more tests | ||
| * Fix minor bugs | ||
|
|
||
| #### 0.4 | ||
|
|
||
| * Rewrote core functionality to use a Class | ||
| * Added 22 Unit Tests (can be run using WP Unit) | ||
|
|
||
| #### 0.3 | ||
|
|
||
| * Ability to extend functionality using filters to manipulate image object. | ||
|
|
||
| #### 0.2 | ||
|
|
||
| * Add some error messages and try to prevent some conflicts with our other plugins. | ||
| * Swap Joe Hoyles helper for HM Core. | ||
|
|
||
| #### 0.1 | ||
|
|
||
| * Add Joe Hoyles helper. | ||
|
|
||
| == Installation == | ||
| ## Installation | ||
|
|
||
| 1. Upload the 'WPThumb' folder to the '/wp-content/plugins/' directory | ||
| 2. Activate the plugin through the 'Plugins' menu in WordPress | ||
| Just install like any other WordPress plugin. | ||
|
|
||
| = The plugin doesn't work, what do I do? = | ||
| ## License | ||
| WP Thumb is licensed under the GPLv2 or later. | ||
|
|
||
| Visit the Issues page of the plugin homepage at: https://github.com/humanmade/WPThumb | ||
| ## Credits | ||
| Created by Human Made for high volume and large-scale sites, such as [Happytables](http://happytables.com/). We run WP Thumb on sites with millions of monthly page views, thousands of sites and terabytes of images. | ||
|
|
||
| ## Contribution guidelines ## | ||
| Written and maintained by [Joe Hoyle](https://github.com/joehoyle). Thanks to all our [contributors](https://github.com/humanmade/WPThumb/graphs/contributors). | ||
|
|
||
| see https://github.com/humanmade/WPThumb/blob/master/CONTRIBUTING.md | ||
| Interested in joining in on the fun? [Join us, and become human!](https://hmn.md/is/hiring/) |