Skip to content

Commit

Permalink
change(readme): made minor adjustments (#476)
Browse files Browse the repository at this point in the history
* Added myself as a maintainer
* Removed scary warning about webpack
framework as we handle this better
* Removed comment about internals

Fixes N/A
  • Loading branch information
codymikol committed Feb 1, 2021
1 parent 5300200 commit d603679
Showing 1 changed file with 10 additions and 14 deletions.
24 changes: 10 additions & 14 deletions README.md
Expand Up @@ -20,21 +20,19 @@

<h2 align="center">Install</h2>

```bash
npm i -D karma-webpack@next
```
npm `npm i -D karma-webpack@next`

<h2 align="center">Usage</h2>
yarn `yarn add -D karma-webpack@next`

**Note: it's very important that you include `webpack` as a framework, otherwise your tests will not run.**
<h2 align="center">Usage</h2>

**karma.conf.js**
```js
module.exports = (config) => {
config.set({
// ... normal karma configuration

// add webpack to your list of frameworks
// make sure to include webpack as a framework
frameworks: ['mocha', 'webpack'],

plugins: [
Expand Down Expand Up @@ -95,14 +93,6 @@ const defaultWebpackOptions = {
},
},
plugins: [],
// Something like this will be auto added by this.configure()
// entry: {
// 'foo-one.test.js': 'path/to/test/foo-one.test.js',
// 'foo-two.test.js': 'path/to/test/foo-two.test.js',
// },
// plugins: [
// new KarmaSyncPlugin()
// ],
};
```

Expand Down Expand Up @@ -167,6 +157,12 @@ webpack: {
<br>
<a href="https://github.com/ryanclark">Ryan Clark</a>
</td>
<td>
<img width="150" height="150"
src="https://avatars.githubusercontent.com/u/13606342?s=460&u=467cf9a106d2bb474cf627ffd4e0eac80d0b4705&v=4">
<br>
<a href="http://codymikol.com">Cody Mikol</a>
</td>
<td align="center">
<img width="150" height="150"
src="https://avatars3.githubusercontent.com/u/2045543?v=4&s=150">
Expand Down

0 comments on commit d603679

Please sign in to comment.