Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README #14

Open
PixnBits opened this issue Jan 4, 2017 · 2 comments
Open

README #14

PixnBits opened this issue Jan 4, 2017 · 2 comments

Comments

@PixnBits
Copy link
Contributor

PixnBits commented Jan 4, 2017

In the README the insertion of the line

It does expect certain, polyfillable, es5 features to be present for which you can use es5-shim for ie8

disturbs the flow of thoughts, currently:

For example events.on works in all browsers ie8+ but it uses the native event system so actual event oddities will continue to exist. If you need robust cross-browser support, use jQuery. If you are just tired of rewriting:

It does expect certain, polyfillable, es5 features to be present for which you can use es5-shim for ie8

if (document.addEventListener)
 return (node, eventName, handler, capture) =>
   node.addEventListener(eventName, handler, capture || false);
else if (document.attachEvent)
 return (node, eventName, handler) =>
     node.attachEvent('on' + eventName, handler);

over and over again, or you need a ok getComputedStyle polyfill but don't want to include all of jQuery, use this.

I was going to open a PR but thought to first ask if there is preference on where to move that line? I was thinking of moving the line to after the thought ends, possibly in parentheses:

For example events.on works in all browsers ie8+ but it uses the native event system so actual event oddities will continue to exist. If you need robust cross-browser support, use jQuery. If you are just tired of rewriting:

if (document.addEventListener)
 return (node, eventName, handler, capture) =>
   node.addEventListener(eventName, handler, capture || false);
else if (document.attachEvent)
 return (node, eventName, handler) =>
     node.attachEvent('on' + eventName, handler);

over and over again, or you need a ok getComputedStyle polyfill but don't want to include all of jQuery, use this.

dom-helpers does expect certain, polyfillable, es5 features to be present for which you can use es5-shim for ie8

or

...
over and over again, or you need a ok getComputedStyle polyfill but don't want to include all of jQuery, use this. (It does expect certain, polyfillable, es5 features to be present for which you can use es5-shim for ie8)

@jquense
Copy link
Member

jquense commented Jan 4, 2017

the first seems fine. It's a fairly important installation instruction so i'd prefer it not to be an aside. but yeah go for it with the PR if you want

@PixnBits
Copy link
Contributor Author

PixnBits commented Jan 5, 2017

Cheers, PR open
very understandable re: installation instruction 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants