Skip to content

Commit

Permalink
More docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Gavin Davies committed Apr 19, 2015
1 parent dee50a3 commit af8bb4d
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
11 changes: 3 additions & 8 deletions README.md
Expand Up @@ -5,16 +5,12 @@ Karma wrapper that makes sure the ES6 and ES5 shims are BOTH available. See also

Modified from https://github.com/pokehanai/karma-es5-shim

[es6-shim][] for [Karma][] including [es5-shim][]

[es6-shim]: https://github.com/paulmillr/es6-shim/
[es5-shim]: https://github.com/es5-shim/es5-shim/
[karma]: http://karma-runner.github.io
[es6-shim](https://github.com/paulmillr/es6-shim/) for [karma](http://karma-runner.github.io) including [es5-shim](https://github.com/es5-shim/es5-shim/).

Motivation
----------

Most versions of PhantomJS do not support ES5, let alone ES6. This meant that you got all sorts of errors when you tried to test ES6 features, even if you had used the [Babel (AKA 6to5 ) transpiler](https://babeljs.io/).
Most versions of PhantomJS do not support ES5, let alone ES6. This meant that you got all sorts of errors when you tried to test ES6 features, even if you had used the [Babel/6to5 transpiler](https://babeljs.io/).

Therefore, we have modified [pokehanai/karma-es5-shim](https://github.com/pokehanai/karma-es5-shim) in the following ways:

Expand Down Expand Up @@ -64,10 +60,9 @@ Use it if you meet all the following criteria:

* You are using PhantomJS in Karma to test ES6
* You use the es6-shim polyfill in your HTML
* You need to use AMD-based module loading
* You need to use AMD-based module loading, e.g. RequireJS (see [Babel's docs](https://babeljs.io/docs/usage/runtime/) for more information)

Do not use it if:

* You can [work around it using Babel's transform](https://github.com/babel/babel/issues/377)
* You are polyfilling in some other way that is accessible to PhantomJS in Karma

2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "karma-es6-shim",
"version": "0.1.2",
"version": "0.1.3",
"description": "es6-shim adapter for Karma",
"keywords": [
"karma",
Expand Down

0 comments on commit af8bb4d

Please sign in to comment.