imaging

imaging
=======

Drawing image in your terminal whithout node-canvas,and the outputing image is more clear than using picture-tube.

__Imaging__, let your terminal outputs more interesting.

!imaing

Installing

For node with npm:

__windows__
``bash
npm install imaging -g
`
__Mac/Linux__

`bash
sudo npm install imaging -g
`

__Node.js Module__
`bash
npm install imaging --save
`

Usage

$3

`bash
imaging https://www.google.com.hk/images/srpr/logo11w.png
`

Using piping:

`bash
echo 'https://www.google.com.hk/images/srpr/logo11w.png' | imaging
`


__options__

Set image width：
`bash
imaging example.png -w 20


or


imaging example.png --width 20
`

Set offset left：
`bash
imaging example.png -l 20


or


imaging example.png --left 20
`

!imaging left

custom pixel char：
`bash
imaging example.png -c @


or

imaging example.png --char #

if error or don't take effect, try wrapping the char with ""

imaging example.png -c "*"
`

imaging char names:
* charmap specific color with specific char, enjoy it.
* square "▇"
* circle "●"
* rectangle" "█"

imaging example.png -c square equal imaging example.png -c ▇


!imaing char

$3

`javascript
var imaging = require('imaging');
imaging.draw('example.jpg', function (resp, status) {
/*
if status == 'success', resp is the image charater string.
conols.log(resp) to render the image in your terminal
else if if status == 'fail', resp is the error message
*/
console.log(status);
console.log(resp);
});

// limit the width for rendering
imaging.draw('example.jpg', { width: 50}, function (resp, status) {
/*
if status == 'success', resp is the image charater string.
conols.log(resp) to render the image in your terminal
else if if status == 'fail', resp is the error message
*/
(status == 'success') && console.log(resp);
});
`

API

`javascript
imaging.draw(path, [options], callback) //path could be a remote link or local resource
`
__options:__ object
* width - the width of image for rendering
* left - set the left offset of image
* char - set the char as pixel of rendered image

__callback:__ function (resp, status)
* status == "fail" - resp: error msg
* status == "success" - resp:imaging string in color format

Example

__Source image:__

!source img

__Draw into terminal:__

!imaging render




Support

Now, it dosn't support rendering images with batch processing. So when you want to render multiple images, only the way to imaging` image for each.