WordPress.org
Get WordPress

Plugin Directory

Changeset 959706


Ignore:
Timestamp:
08/03/2014 10:07:18 PM (12 years ago)
Author:
kylereicks
Message:

readme updates

File:
1 edited

Legend:

Unmodified
Added
Removed

  • picturefillwp/trunk/readme.txt

    r942963 r959706  
    1212
    1313== Description ==
     14
     15**Note: This is an implementation of [Picturefill.js version 1.2.x](https://github.com/scottjehl/picturefill/tree/1.2). For an implementation of [Picturefill.js 2.x](http://scottjehl.github.io/picturefill/), see the [master branch of the GitHub repository](https://github.com/kylereicks/picturefill.js.wp/tree/master).**
    1416
    1517Picturefill.WP is a simple and option-less plugin to serve HDPI and responsive images on a WordPress website.
    … …  
    104106= Where are the plugin options? =
    105107
    106 There aren't any. Breakpoints, as well as retina and responsive images are created based on the image sizes in your media settings.
     108There aren't any. Breakpoints, as well as retina and responsive images are created based on the image sizes in your media settings. See [Extending and Customizing Picturefill.WP 1](https://github.com/kylereicks/picturefill.js.wp/tree/1.3.x#extending-and-customizing-picturefillwp-1) For information on customizing the plugin.
     109
     110= Should I use this plugin (1.3.x), or the implementation of [Picturefill 2.0 on GitHub](https://github.com/kylereicks/picturefill.js.wp/tree/master)? =
     111
     112There are a number of reasons why you might want to use either. The Picturefill project site provides a basic [breakdown of the two versions](http://scottjehl.github.io/picturefill/#download), as well as some [support caveats to keep in mind for version 2](http://scottjehl.github.io/picturefill/#gotchas).
    107113
    108114= Is this plugin on GitHub? =
    109115
    110 Yes it is. [Picturefill.WP](https://github.com/kylereicks/picturefill.js.wp)
     116Yes it is. [Picturefill.WP](https://github.com/kylereicks/picturefill.js.wp/tree/1.3.x)
    111117
    112118= Where can I find information about extending the plugin? =
    113119
    114 See the [Extending Picturefill.WP](https://github.com/kylereicks/picturefill.js.wp#extending-picturefillwp) subsection of the GitHub repository for a list of plugin hooks and examples.
     120See the [Extending Picturefill.WP](https://github.com/kylereicks/picturefill.js.wp/tree/1.3.x#extending-and-customizing-picturefillwp-1) subsection of the GitHub repository for a list of plugin hooks and examples.
    115121
    116122= Can I use this plugin with another plugin that I always use? =
    117123
    118 Probably. See the [using Picturefill.WP with other plugins](https://github.com/kylereicks/picturefill.js.wp#use-with-other-plugins) section of the documentation on GitHub for a few of the plugins that have been discovered may need special consideration.
     124Probably. See the [using Picturefill.WP with other plugins](https://github.com/kylereicks/picturefill.js.wp/tree/1.3.x#use-with-other-plugins) section of the documentation on GitHub for a few of the plugins that have been discovered may need special consideration.
    119125
    120126= Why does this plugin use an "adapted" version of picturefill.js =
    121127
    122 The standard version of [picturefill.js](https://github.com/scottjehl/picturefill) will work well enough with Picturefill.WP; however, Picturefill.WP has a slightly diferent goal than picturefill.js. Picturefill.js aims to pollyfill the proposed `<picture>` element. It expects a special `<picture>` like markup, and outputs the appropriate `<img>`, but the resulting `<img>` does not include a class, id or other attribute. The generated `<img>` tags can only be targeted by the attributes of its parent elements. Picturefill.WP aims to take an `<img>` and then output an `<img>` exactly like it, apart form the width or pixel density. This way, `<img>` tags can be targeted without regard to the `<picture>` syntax.
     128The standard version of [picturefill.js](https://github.com/scottjehl/picturefill) will work well enough with Picturefill.WP; however, Picturefill.WP has a slightly different goal than picturefill.js. Picturefill.js aims to pollyfill the proposed `<picture>` element. It expects a special `<picture>` like markup, and outputs the appropriate `<img>`, but the resulting `<img>` does not include a class, id or other attribute. The generated `<img>` tags can only be targeted by the attributes of its parent elements. Picturefill.WP aims to take an `<img>` and then output an `<img>` exactly like it, apart form the width or pixel density. This way, `<img>` tags can be targeted without regard to the `<picture>` syntax.
    123129
    124130= Are there any plans to update this plugin to Picturefill 2.0 =
    125131
    126 A new version of Picturefill.WP using Picturefill 2.x is in the works. Because of significant diferences between Picturefill 1.x and Picturefill 2.x, the new Picturefill.WP 2 will be maintained alongside the original Picteufill.WP 1.3.x. I will update this plugin with more details as they become available.
    127 
     132The plugin in this repository will remain an implementation of Picturefill 1.2. If you are looking for an implementation of Picturefill 2.0, please see the [master branch of the GitHub repository](https://github.com/kylereicks/picturefill.js.wp/tree/master).
    128133
    129134== Advanced Use ==
    … …  
    141146###Helper Functions
    142147
    143 See the [helper functions](https://github.com/kylereicks/picturefill.js.wp#helper-functions) section of the documentatin on GitHub.
     148See the [helper functions](https://github.com/kylereicks/picturefill.js.wp#helper-functions) section of the documentation on GitHub.
    144149
    145150== Changelog ==
    … …  
    179184* Fix error in template hooks
    180185* Add minified templates
    181 * Add example to minify HTML ouput
     186* Add example to minify HTML output
    182187
    183188= 1.2.2 =
    … …  
    206211= 1.1 =
    207212* Allow for responsive images for non-standard sizes
    208 * Add a `min-size` class to limit the resposiveness of an image.
     213* Add a `min-size` class to limit the responsiveness of an image.
    209214
    210215= 1.0 =
Note: See TracChangeset for help on using the changeset viewer.