From 21806dde5d5c09f44b3fc430f6ec524fe84000eb Mon Sep 17 00:00:00 2001 From: "Johannes J. Schmidt" Date: Mon, 26 May 2014 17:56:12 +0200 Subject: [PATCH] Couchmagick with capital D --- README.md | 16 ++++++++-------- index.js | 2 +- lib/couchmagick-stream.js | 2 +- package.json | 4 ++-- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a839707..fed69bf 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ -# couchmagick +# Couchmagick Run ImageMagicks `convert` on CouchDB documents. -couchmagick runs as an [os_daemon](http://docs.couchdb.org/en/1.5.x/config/externals.html#os_daemons), +Couchmagick runs as an [os_daemon](http://docs.couchdb.org/en/1.5.x/config/externals.html#os_daemons), which means that CouchDB manages the process and you can configure it using CouchDBs configuration mechanism, which is both a huge win. Versions and commandline arguments which are passed to `convert` are defined in design documents under a `couchmagick` section. @@ -9,16 +9,16 @@ Versions and commandline arguments which are passed to `convert` are defined in couchmagicks stream based implementation provides low memory footprint. ## Installation -The installation of couchmagick is dead simple. +The installation of Couchmagick is dead simple. Make sure you have `ImageMagick` installed, eg on Debian: `apt-get install imagemagick` -Install couchmagick via npm: +Install Couchmagick via npm: `npm install couchmagick -g` ## Commandline Client -You can run couchmagick from the commandline: +You can run Couchmagick from the commandline: ```shell couchmagick ``` @@ -31,14 +31,14 @@ couchmagick --username bernd --password secure --whitelist projects --concurrenc ``` ## Daemon Configuration -Add couchmagick to `os_daemons` config section (eg. in local.ini): +Add Couchmagick to `os_daemons` config section (eg. in local.ini): ```ini [os_daemons] couchmagick = couchmagick ``` -Now CouchDB takes care of the couchmagick process. +Now CouchDB takes care of the Couchmagick process. ```ini [couchmagick] @@ -61,7 +61,7 @@ blacklist = _users,_replicator ``` ## Imagemagick Configuration -Add a `couchmagick` property to a design document. couchmagick will process all +Add a `couchmagick` property to a design document. Couchmagick will process all databases which have such a design document. ### Minimal Example diff --git a/index.js b/index.js index 5b080de..c871608 100755 --- a/index.js +++ b/index.js @@ -1,5 +1,5 @@ #!/usr/bin/env node -/* couchmagick: Run ImageMagicks `convert` on CouchDB documents. +/* Couchmagick: Run ImageMagicks `convert` on CouchDB documents. * * (c) 2014 Johannes J. Schmidt, null2 GmbH, Berlin */ diff --git a/lib/couchmagick-stream.js b/lib/couchmagick-stream.js index 0fd2235..b7858aa 100644 --- a/lib/couchmagick-stream.js +++ b/lib/couchmagick-stream.js @@ -1,4 +1,4 @@ -/* couchmagick: Run ImageMagicks `convert` on CouchDB documents. +/* Couchmagick: Run ImageMagicks `convert` on CouchDB documents. * * (c) 2014 Johannes J. Schmidt, null2 GmbH, Berlin */ diff --git a/package.json b/package.json index 991d700..09cc858 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "couchmagick", - "version": "2.1.1", - "description": "Run ImageMagicks `convert` on CouchDB documents.", + "version": "2.1.2", + "description": "Couchmagick runs ImageMagicks `convert` on CouchDB documents.", "main": "index.js", "preferGlobal": true, "bin": "index.js",