Written README file.

Author: André König

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - '0.10'

README.md

@@ -0,0 +1,98 @@
+# imacss
+
+An application and library that transforms image files to [data URIs (rfc2397)](https://www.ietf.org/rfc/rfc2397.txt) and embeds them into a single CSS file as background images.
+
+Let's say you have a web-based frontend which embeds a lot of images (e.g. icons). This referencing produces HTTP requests for every single image. What if you would like to minimize it to just one request? That is something `imacss` can do for you.
+
+## What?
+
+Okay, enough words. Let's dive straight into a transformation example. If we assume that you have two SVGs, like `github.svg` and `quitter.svg`, `imacss` would generate this CSS code for you.
+
+    .imacss.imacss-github {
+        background:url(data:image/svg+xml;base64,iVBORw0KGgoAAAANSUhEBg...);
+    }
+
+    .imacss.imacss-quitter {
+        background:url(data:image/svg+xml;base64,iVBORw0KGgoAAAANSUhADA...);
+    }
+
+
+## CLI
+
+`imacss` comes with a command-line interface which pipes the output to stdout by default (yeah, plain old text streams FTW!).
+
+### Installation
+
+Install with [npm](https://npmjs.org/package/imacss) globally.
+
+    npm install -g imacss
+
+### Usage examples
+
+Embed all SVGs in a particular directory and all its subdirectories (will pipe the output to stdout).
+
+    imacss "~/projects/webapp/images/**/*.svg"
+
+Embed all SVGs in a particular directory and transfer them to a CSS file which will be saved in the CWD.
+
+    imacss "~/projects/webapp/images/*.svg" images.svg.css
+
+Embed all SVGs _and_ PNGs in a particular directory and transfer them to a CSS file which will be saved in the CWD.
+
+    imacss "~/projects/webapp/images/*.{svg,png}" images.css
+
+If you don't like the `imacss` selector namespace you are able to modify it as well.
+
+    imacss "~/projects/webapp/images/*.{svg,png}" images.css foobar
+
+will produce this selector structure in the CSS file:
+
+    .foobar.foobar-github {...}
+
+## API
+
+If you would like to use the `imacss` functionality within your application, there is an API for that.
+
+### Install
+
+Install with [npm](https://npmjs.org/package/imacss)
+
+    npm install --save imacss
+
+### Methods
+
+#### convert(glob[, namespace]);
+
+Converts the image files from the specified glob and returns a stream with the CSS selectors that can be piped to somewhere else.
+
+**Arguments**
+
+`glob`
+
+The instruction to search for images.
+
+`namespace` (optional; default=imacss)
+
+The CSS selector namespace.
+
+### Usage example
+
+    var imacss = require('imacss');
+
+    imacss
+        .transform('/path/to/your/images/*.png')
+        .on('error', function (err) {
+            error('Transforming images failed: ' + err);
+        })
+        .pipe(process.stdout);
+
+
+## Changelog
+
+### Version 0.1.0 (20140211)
+
+- Initial Release. Implemented the core functionality (CLI and API).
+
+## Author
+
+Copyright 2014, [André König](http://iam.andrekoenig.info) (andre.koenig@posteo.de)

bin/imacss

@@ -28,7 +28,6 @@ var fs     = require('fs'),
  *
  * @param  {string} message The message that should be printed.
  *
- *
  */
 function error (message) {
     console.error('\u001b[31m' + message + '\u001b[39m');
@@ -52,15 +51,37 @@ function normalizePath (normalizable) {
     return path.resolve(normalizable)
 }
 
+/**
+ * Simple function to determine if a given string
+ * is a path.
+ *
+ * @param  {string} str The path that should be checked.
+ *
+ * @return {Boolean}
+ *
+ */
+function isPath (str) {
+    return (~str.indexOf(path.sep) || ~str.indexOf('.css'));
+}
+
 if (!args.glob) {
     return error('Please define the glob to your images.');
 }
 
+//
+// Check if a css file has been defined.
+//
+if (args.cssfile && !isPath(args.cssfile)) {
+    args.cssclass = args.cssfile;
+
+    delete args.cssfile;
+}
+
 args.glob = normalizePath(args.glob);
 
 imacss
     .transform(args.glob, args.cssclass)
     .on('error', function (err) {
         error('Converting images failed: ' + err);
     })
-    .pipe(args.cssfile ? fs.createWriteStream(args.cssfile) : process.stdout)
+    .pipe(args.cssfile ? fs.createWriteStream(args.cssfile) : process.stdout);

lib/purify.js

@@ -45,7 +45,7 @@ Purify.prototype._transform = function _transform (vfile, enc, cb) {
     var image = {};
 
     if (!vfile.contents) {
-        return cb(new Error('There are no images at the given path.'));
+        return cb(new Error('Please define a valid glob, which will find some image files.'));
     }
 
     //

package.json

@@ -1,10 +1,15 @@
 {
   "name": "imacss",
   "version": "0.1.0",
-  "description": "Transforms image files to base64 encoded data URIs and embeds them into CSS files.",
+  "description": "An application and library that transforms image files to data URIs and embeds these into a single CSS file.",
+  "author": {
+    "name": "André König",
+    "email": "andre.koenig@posteo.de"
+  },
+  "license": "MIT",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "gulp"
   },
   "bin": {
     "imacss": "./bin/imacss"
@@ -13,14 +18,15 @@
     "type": "git",
     "url": "git@github.com:akoenig/imacss.git"
   },
+  "engines": {
+    "node": ">=0.10.0"
+  },
   "keywords": [
     "css",
     "images",
     "data uri",
     "base64"
   ],
-  "author": "André König <andre.koenig@posteo.de>",
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/akoenig/imacss/issues"
   },