forked from scottjehl/picturefill
-
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.
Merge pull request scottjehl#538 from baloneysandwiches/readme
cleanup 3.0 Readme
- Loading branch information
Showing
1 changed file
with
13 additions
and
12 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,26 +1,27 @@ | ||
| # Picturefill | ||
| # Picturefill | ||
| A [responsive image](http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded-content.html#embedded-content) polyfill. | ||
| * Authors: Scott Jehl, Mat Marquis, Shawn Jansepar (2.0 refactor lead), and many more: see Authors.txt | ||
| * Authors: See [Authors.txt](https://github.com/scottjehl/picturefill/blob/3.0/Authors.txt) | ||
| * License: MIT | ||
|
|
||
| [](https://travis-ci.org/scottjehl/picturefill) | ||
|
|
||
| Picturefill has two versions: | ||
| * Version 2 is a strict polyfill of the [Picture element draft specification](http://www.whatwg.org/specs/web-apps/current-work/multipage/embedded-content.html#embedded-content) and is the main version in development. | ||
| * Version 1 mimics the Picture element pattern with `span` elements. It is maintained in the 1.2 branch. | ||
| Picturefill has three versions: | ||
|
|
||
| ## Usage, Demos, Docs | ||
| To find out how to use Picturefill on your sites, visit the project and demo site: | ||
| * Version 3 is currently a beta release. It boasts a deadly accurate set of parsers, and matches a number of native behaviors that Picturefill 2.x didn’t—but also meant a near-complete rewrite. **That means we need testers.** Please give the 3.0.0 beta a try, and [let us know](https://github.com/scottjehl/picturefill/issues) if you run into any issues. | ||
|
|
||
| * Version 2.3.1 is the current stable. Due to a [serious bug](https://css-tricks.com/please-update-picturefill/), please immediately update to 2.3.1 if you are currently using a earlier version. | ||
|
|
||
| [Picturefill Documentation, Downloads, and Demos Site](http://scottjehl.github.com/picturefill/) | ||
| * Version 1 mimics the Picture element pattern with `span` elements. It is no longer maintained. | ||
|
|
||
| ## Usage, Demos, Docs | ||
| To find out how to use Picturefill, visit the [project site](http://scottjehl.github.com/picturefill/). | ||
|
|
||
| ## Contributing | ||
| For information on how to contribute code to Picturefill, check out `CONTRIBUTING.md` | ||
| For information on how to contribute code to Picturefill, check out `CONTRIBUTING.md`. | ||
|
|
||
| ## Issues | ||
| If you find a bug in Picturefill, please add it to [the issue tracker](https://github.com/scottjehl/picturefill/issues) | ||
|
|
||
| If you find a bug in Picturefill, please add it to [the issue tracker](https://github.com/scottjehl/picturefill/issues). | ||
|
|
||
| ## Support | ||
|
|
||
| Picturefill supports a broad range of browsers and devices (there are currently no known unsupported browsers), provided that you stick with the markup conventions provided. | ||
| There are currently no known unsupported browsers, provided that you use the markup patterns provided. |