Permalink
Browse files

Initial commit

  • Loading branch information...
1 parent 8615e95 commit 065d1a19473bc91ce904538e827c9f59ae0287f8 @kmiyashiro committed Apr 26, 2012
View
@@ -12,4 +12,5 @@ logs
results
node_modules
-npm-debug.log
+npm-debug.log
+.DS_Store
View
@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kelly Miyashiro
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,4 +1,34 @@
-grunt-mocha-task
-================
+# grunt-mocha
-Grunt task for running mocha specs in a headless browser (PhantomJS)
+(package/README format heavily borrowed from [grunt-jasmine-task](https://github.com/jzaefferer/grunt-css) and builtin QUnit task)
+
+[Grunt](https://github.com/cowboy/grunt) plugin for running Mocha browser specs in a headless browser (PhantomJS)
+
+## Getting Started
+
+Install this grunt plugin next to your project's [grunt.js gruntfile][getting_started] with: `npm install grunt-mocha`
+
+(ie. the plugin is installed locally. If you want to install it globally - which is not recommended - check out the official [grunt documentation][plugin_docs])
+
+Then add this line to your project's `grunt.js` gruntfile at the bottom:
+
+```javascript
+grunt.loadNpmTasks('grunt-mocha');
+```
+
+Also add this to the ```grunt.initConfig``` object in the same file:
+
+```javascript
+mocha: {
+ index: ['specs/index.html']
+},
+```
+Replace ```specs/index.html``` with the location of your mocha spec running html file.
+
+Now you can run the mocha task with:
+
+```grunt mocha```
+
+## License
+Copyright (c) 2012 Kelly Miyashiro
+Licensed under the MIT license.
View
@@ -0,0 +1,41 @@
+{
+ "name": "grunt-mocha",
+ "description": "Grunt task for running Mocha specs",
+ "version": "0.1.0",
+ "homepage": "https://github.com/kmiyashiro/grunt-mocha",
+ "author": {
+ "name": "Kelly Miyashiro",
+ "email": "miyashiro.kelly@gmail.com",
+ "url": "http://non-diligent.com"
+ },
+ "repository": {
+ "type": "git",
+ "url": "git://github.com/kmiyashiro/grunt-mocha.git"
+ },
+ "bugs": {
+ "url": "https://github.com/kmiyashiro/grunt-mocha/issues"
+ },
+ "licenses": [
+ {
+ "type": "MIT",
+ "url": "https://github.com/kmiyashiro/grunt-mocha/blob/master/LICENSE-MIT"
+ }
+ ],
+ "main": "grunt.js",
+ "engines": {
+ "node": "*"
+ },
+ "scripts": {
+ "test": "grunt test"
+ },
+ "dependencies": {
+ "grunt": "~0.3.8",
+ "temporary": "~0.0.2"
+ },
+ "devDependencies": {
+ "grunt": "~0.3.8"
+ },
+ "keywords": [
+ "gruntplugin"
+ ]
+}
Oops, something went wrong.

0 comments on commit 065d1a1

Please sign in to comment.