From b514a1e27e6a86452c906afaab5131d508e55864 Mon Sep 17 00:00:00 2001 From: Ken Elf Mathieu Sternberg Date: Thu, 9 Aug 2012 18:51:11 -0700 Subject: [PATCH] Added demo task, and updated README to point to demo. --- README.md | 12 ++++++++++-- grunt.js | 1 + 2 files changed, 11 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d464e1e..f043944 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ grunt.loadNpmTasks('grunt-couchapp'); ## Documentation You'll want to add some configuration for the plug-in. This plugin -provides three tasks, *mkcouchdb* to create new databases, *rmcouchdb* -to delete all data and drop an existing database, and *couchapp*, +provides three tasks, `mkcouchdb` to create new databases, `rmcouchdb` +to delete all data and drop an existing database, and `couchapp`, which installs a specified couchapp into the database. mkcouchdb: { @@ -71,6 +71,14 @@ possible to write in your configuration file: Note, however, that if you call 'rmcouchdb' without a sub-argument, in keeping with grunt's standards, it will drop *all* of your databases! +## Demo + +It is possible to run the entire toolchain (drop, initialize, and +install) with the grunt.js file by calling `grunt demo`. As long as +you have a local couchdb running in admin-party mode, and browse to +`http://localhost:5984/grunt-couchapp-demo/_design/app/index.html` +You should get back a happy message. + ## Contributing In lieu of a formal styleguide, take care to maintain the existing diff --git a/grunt.js b/grunt.js index 0e3ad16..cf738b7 100644 --- a/grunt.js +++ b/grunt.js @@ -58,4 +58,5 @@ module.exports = function(grunt) { // Default task. grunt.registerTask('default', 'lint test'); + grunt.registerTask('demo', 'rmcouchdb:demo mkcouchdb:demo couchapp:demo'); };