Skip to content

Commit

Permalink
Compatibility table and typos
Browse files Browse the repository at this point in the history
  • Loading branch information
Noah Rodenbeek committed Jun 17, 2016
1 parent d14d33f commit d9be73e
Showing 1 changed file with 22 additions and 11 deletions.
33 changes: 22 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,31 @@ A flexible, light-weight module for creating custom components

[http://nominalaeon.github.io/french-dip/](http://nominalaeon.github.io/french-dip/)

## Compatibility

<table>
<thead>
<th>IE11</th>
<th>≥IE9</th>
<th>≤IE8</th>
<th>any other browser</th>
</thead>
<tr>
<td>good</td>
<td>so-so</td>
<td>nope</td>
<td>recommended</td>
</tr>
</table>

Because of a crucial incompatibility, FrenchDipJS will not work below **IE9**.

Any IE below 11 will work with the caveat that passing settings through the markup on data attributes is impossible.

## Contributor Guidelines

### Submitting issues

### Test case required

**All bug reports and problem issues require a jsFiddle**.
[Please fork this JSFiddle as a baseline](https://jsfiddle.net/NoahRodenbeek/m0fr5jsm/).

Expand All @@ -29,17 +48,9 @@ You must provide a clear and simple way to reproduce the issue with the provided

*Please note that while FrenchDip is open source, this is still my baby, and by submitting a pull request you are authorizing me to edit or modify it in any way shape or form. You will be listed in Github as a contributor, but I have and will continue to steer the direction of this project.*

## Compatibility Caveats

Some crucial Array and Object prototype incompatabilities mean *FrenchDip will not work below IE9*.

Because the HTMLElement.dataset polyfill is as large as FrenchDip itself, any IE below 11 won't be able to pass data attribute settings to components.

tl;dr: IE11 good, IE9 meh, IE8 nope.

## Acknowledgements

FrenchDipJS is named for [Caleb Kniffen](https://github.com/ckniffen), who accidentally spilled a tub of au jus on his shirt, covered it with a buttoned overshirt, but was later found out because our dev cube smelled like beef. FrenchDipJS is based on an original implementation by Caleb for an enterprise project that used it to connect dozens of custom components being written by our large development team. It has been largely rewritten and made into a stand-alone project to provide more flexibility and allow an easier point of entry. Thanks, Caleb, you make me a better developer.
FrenchDipJS is named for [Caleb Kniffen](https://github.com/ckniffen), who accidentally spilled a tub of au jus on himself, covered the evidence with a buttoned overshirt, but was later found out because our dev cube smelled like a butcher shop. FrenchDipJS is based on the original implementation by Caleb for an enterprise-level project that used it to connect dozens of custom components created by a large development team. It has been largely rewritten and made into a stand-alone project to provide more flexibility and allow an easier point of entry. Thanks, Caleb, you make me a better developer.

The first person I was brave enough to show this project to was [Ken Wheeler](https://github.com/kenwheeler). His criticisms and encouragement are what got me to the finish line. Then I stole his [contributor guidelines](https://github.com/kenwheeler/slick/blob/master/CONTRIBUTING.markdown). Thanks, man!

Expand Down

0 comments on commit d9be73e

Please sign in to comment.