karma-runner
Add documentation to the main site.
I second this "issue" -- the documentation located here: https://github.com/karma-runner/grunt-karma/blob/master/README.md doesn't solve many questions:
- What is the grunt-karma ? An individual application written on javascript, or it's a plugin to Karma, or it's a plugin to Grunt ? I understand what the answer is "plugin to grunt", but still, it should be written
- What problem this plugin solves ? What for it was created ?
In documentation there is a section "Here's an example that puts the config in the Gruntfile" -- It's not quite obvious what "that" is. And the content of the example looks like says which files to load... Maybe it should sounds like "Here is an example how to specify which files to test" ?
In documentation there is a sentence "You can override any of the config file's settings by putting them directly in the Gruntfile". It's not obvious what "config file" you mean, because before this documentation told us about only one config file: Gruntfile. And now it says about some other "config file". What is this "config file" ?
The next part says about "Log Level". Does it change the log level of the Grunt program ? Or does it change log level of Karma ? Or it does it change log level of "grunt-karma" plugin ? Who's logLevel does it change ?
There is a paragraph which starts from "If you have multiple targets" in documentation. The question which comes to my mind is "what is the target?" Is it a grunt task ? Is it something from Grunt world or Karma's ?
I guess in section where docs says about "Config your watch task to run the karma task with the :run flag" it should say "Config your watch task for the "grunt-contrib-watch" plugin...." to make it clean whose "watch" section user should edit. Yes, it's obvious, but it should be also clear.
In the last part, "Using additional client.args", it's not very clear what "client.args" is and what "mypattern" is as well and what "--grep" option is.
I can help with documentation on some parts, if you like it.
It also states:
This current version uses
[email protected].For using older versions see the old releases of grunt-karma.
Yet npm reports the latest version as 2.0.0...
