Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

update readme

  • Loading branch information...
commit 170122a143f90f18b5a2fb2100bc28dd6124a8f8 1 parent 82db016
@madhums madhums authored
Showing with 23 additions and 44 deletions.
  1. +23 −44 README.md
View
67 README.md
@@ -1,22 +1,28 @@
Imager
=============
-A Node.js module to easily resize, crop and upload images to Rackspace cloudfiles. Possible to add different versions of the same file in cropped or resized variant.
+A Node.js module to easily resize, crop and upload images (with different variants and presets) to Rackspace cloudfiles.
## Installation
```sh
$ npm install imager
```
+**Note** : _Uptil v0.0.8 the module supported filesystem uploads and external (remote) image uploads, but the module was completely re-written
+to use async and make it much faster. The 0.0.9 version of the module doesn't support file system uploads.
+I will try to add it back soon. You can revert back to older versions if you need filesystem support etc_
+
## Usage
**You need to create imager configuration file with image variants and your storages**
-Checkout the example config file `imager-example.json` in the repo
+Checkout the example config file `imager-example.js` in the repo
```js
var Imager = require('imager');
-var imager = new Imager({storage : "rs", config_file: "path/to/imager_config.json"})
+ , imagerConfig = require('path/to/imager-config.js')
+ , imager = new Imager(imagerConfig, 'Rackspace')
```
+
### Uploading file(s)
The callback recieves an err object, a files array (containing the names of the files which were
@@ -24,55 +30,22 @@ uploaded) and the cdnUri.
So if you have a variant, say `thumb`, then you can access the image by `cdnUri+'/'+'thumb_'+files[0]`. This would be the complete url of the image
-1. **Form upload**
+1. **Form upload (multiple images)**
```js
- imager.upload(req, function(err, files, cdnUri){
+ imager.upload(req.files.image, function(err, cdnUri, files) {
// do your stuff
}, 'projects')
```
-2. **Upload files from disk**
-
- You can upload a single file or multiple files by providing the paths to all the files
- in an array
-
- _Upload Single file from disk_:
-
- ```js
- imager.upload('path/to/file.jpg', function(err, files, cdnUri){
- // do your stuff
- }, 'projects')
- ```
-
- _Upload multiple files from disk_:
-
- ```js
- var files = ['file1.jpg', 'file2.jpg']
- imager.upload(files, function(err, files, cdnUri){
- // do your stuff
- }, 'projects')
- ```
+ Here, `projects` is your scope or variant. If you don't specify the scope or the variant, imager
+ will try to look for a default variant named `default`. You must either specify a variant like
+ above or provide a `default` variant.
-3. **Upload files from remote url**
-
- ```js
- imager.uploadRemoteImage('https://www.google.co.in/images/srpr/logo3w.png', function(err, files, cdnUri){
- // do your stuff
- }, 'projects')
- ```
### Removing file(s)
-1. **Remove a single file**
-
- ```js
- imager.remove('1330838831049.png', function (err) {
- // do your stuff
- }, 'projects')
- ```
-
-2. **Remove multiple files**
+1. **Remove from cloudfiles**
```js
var files = ['1330838831049.png', '1330838831049.png']
@@ -81,10 +54,16 @@ So if you have a variant, say `thumb`, then you can access the image by `cdnUri+
}, 'projects')
```
+ Even here, if the variant is not specified, imager will try to look for the `default` variant. If neither
+ of them are provided, you will get an error.
+
+## Debugging
+If you specify `debug: true` in the imager config, you can see the logs of uploaded / removed files.
+
## To-do's
* Support amazon storage
* Support filesystem storage
-* <strike>Remove using of `eval`</strike>
-* <strike>Add functionality to remove files</strike>
* Write tests
+
+**credits :** Initially inspired by [Alleup](https://github.com/tih-ra/alleup)
Please sign in to comment.
Something went wrong with that request. Please try again.