Added support for local files and documentation.

Author: Shogun

.jshintrc

@@ -0,0 +1,3 @@
+{
+  "curly": false
+}

.travis.yml

@@ -1,4 +1,10 @@
+#
+# This file is part of the fastimage node module. Copyright (C) 2015 and above Shogun <shogun@cowtech.it>.
+# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
+#
+
 language: node_js
+script: npm run-script travis-ci
 node_js:
   - "0.12"
   - "0.11"

CHANGELOG.md

@@ -1,3 +1,11 @@
+
+### 2015-03-14 / 0.2.0 - The PI release!
+
+* Added support for analyzing local files.
+* Added `realPath`, `realUrl` and `size` to the returned objects.
+* Added documentation.
+* Improved README.
+
 ### 2015-03-10 / 0.1.1
 
 * Export `FastImageError` as well.

README.md

@@ -10,13 +10,115 @@ FastImage finds the size or type of an image given its URL by fetching as little
 
 http://sw.cowtech.it/fastimage
 
+The supported image type are (thanks to the [image-size](https://github.com/netroy/image-size) module):
+
+* BMP
+* GIF
+* JPEG
+* PNG
+* PSD
+* TIFF
+* WebP
+* SVG
+
 ## Usage
 
-TODO
+### Callback style
+
+To get the image informations, call `fastimage.analyze` passing the URL (can be also a local file path) and a callback.
+
+```javascript
+var fastimage = require("fastimage");
+fastimage.analyze("http://placehold.it/100x100", function(error, information){
+  if(error){
+    // ...
+  else{
+    // ...
+  }
+});
+```
+
+For the details about the second parameter of the callback, see [fastimage.analyze](#user-content-fastimageanalyzeurl-callback), 
+[fastimage.size](#user-content-fastimagesizeurl-callback) and [fastimage.type](#user-content-fastimagetypeurl-callback).
+
+### Promise style
+
+# TODO
+
+### Stream style
+
+# TODO
 
 ## Supported implementations.
 
-TODO
+Chalkbars supports and has been tested on [NodeJS](http://nodejs.org) 0.10+ and [io.js](http://iojs.org) 1.0+.
+
+## API Documentation
+
+### fastimage.analyze(url, callback)
+  
+Analyzes a URL (local or remote) and return the image informations.
+
+The signature of the callback is `function(error, info)`.
+
+The first argument of the callback, when failed, will be a [FastImageError](#user-content-fastimageFastImageError) instance.
+
+The second argument of the callback, when successful, will be a object containing the image informations.
+
+Specifically, when the URL is a remote URL, the object will be similar to this:
+
+```javascript
+{
+  "width": 1000, // The width of the image in pixels.
+  "height": 1000, // The height of the image in pixels.
+  "type": "gif", // The type of the image. Can be `bmp`, `gif`, `jpeg`, `png`, `psd`, `tif`, `webp` or `svg`.
+  "url": "http://placehold.it/1000x1000.gif", // The original URL of the image.
+  "realUrl": "http://placehold.it/1000x1000.gif", // The real URL of the image after all the redirects. It will be omitted if equals to the URL.
+  "size": 24090, // The size of the image (in bytes). Present only if the server returned the Content-Length HTTP header.
+  "transferred": 979, // The amount of data transferred (in bytes) to identify the image.
+  "time": 171.43721 // The time required for the operation, in milliseconds.
+}
+```
+
+When the URL is a local file the object will be similar to this:
+
+```javascript
+{
+  "width": 150, // The width of the image in pixels.
+  "height": 150, // The height of the image in pixels.
+  "type": "png", // The type of the image. Can be `bmp`, `gif`, `jpeg`, `png`, `psd`, `tif`, `webp` or `svg`.
+  "path": "1.png", // The original path of the image.
+  "realPath": "/home/user/1.png", // The absolute path of the image. It will be omitted if equals to the path.
+  "size": 24090, // The size (in bytes) of the image.
+  "time": 14.00558 // The time required for the operation, in milliseconds.
+}
+```
+
+### fastimage.size(url, callback)
+
+Analyzes a URL (local or remote) and return the image size.
+
+The signature of the callback is `function(error, dimensions)`.
+
+The first argument of the callback, when failed, will be a [FastImageError](#user-content-fastimageFastImageError) instance.
+
+The second argument of the callback, when successful, will be a object containing the fields `width` and `height` in pixels.
+
+### fastimage.type(url, callback)
+
+Analyzes a URL (local or remote) and return the image type.
+
+The signature of the callback is `function(error, type)`.
+
+The first argument of the callback, when failed, will be a [FastImageError](#user-content-fastimageFastImageError) instance.
+
+The second argument of the callback, when successful, will be the type of the image.
+
+### fastimage.FastImageError
+
+This error will be returned as the first argument of the callbacks if anything goes wrong.
+
+It always have the `message` and `code` fields set.
 
 ## Contributing to fastimage