README.md in httpthumbnailer-client-1.0.0 vs README.md in httpthumbnailer-client-1.1.0

- old
+ new

@@ -21,30 +21,46 @@ # with API server listening on localhost port 3100 # see the API server documentation for available operations, formats and options # generate single thumbnail from image data (single thumbnail API) thumbnail = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data, 'crop', 60, 30, 'jpeg') -thumbnail.mime_type # => 'image/jpeg' -thumbnail.data # => 60x30 thumbnail JPEG data String +thumbnail.mime_type # => 'image/jpeg' +thumbnail.width # => 60 +thumbnail.height # => 30 +thumbnail.data # => 60x30 thumbnail JPEG data String # generate set of thumbnails from image data (multipart API) thumbnails = HTTPThumbnailerClient.new('http://localhost:3100').thumbnail(data) do thumbnail 'crop', 60, 30, 'jpeg' thumbnail 'crop', 80, 80, 'png' thumbnail 'pad', 40, 40, 'png' end thumbnails[0].mime_type # => 'image/jpeg' +thumbnails[0].width # => 60 +thumbnails[0].height # => 30 thumbnails[0].data # => 60x30 thumbnail JPEG data String thumbnails[1].mime_type # => 'image/png' +thumbnails[1].width # => 80 +thumbnails[1].height # => 80 thumbnails[1].data # => 80x80 thumbnail PNG data String thumbnails[2].mime_type # => 'image/png' +thumbnails[2].width # => 40 +thumbnails[2].height # => 40 thumbnails[2].data # => 40x40 thumbnail PNG data String thumbnails.input_mime_type # => 'image/jpeg' - detected input image format by API server (content based) +thumbnails.input_width # => 800 - detected input image width by API server (content based) +thumbnails.input_height # => 600 - detected input image height by API server (content based) + +# just identify the image +id = HTTPThumbnailerClient.new('http://localhost:3100').identify(data) +id.mime_type # => 'image/jpeg' +id.width # => 800 +id.height # => 600 ``` For more details see RSpec for [single thumbnail API](http://github.com/jpastuszek/httpthumbnailer-client/blob/master/spec/thumbnail_spec.rb) and [multipart API](http://github.com/jpastuszek/httpthumbnailer-client/blob/master/spec/thumbnails_spec.rb). ### CLI tool @@ -53,14 +69,17 @@ ```bash # start thumbnailing server (to stop: kill `cat httpthumbnailer.pid`) httpthumbnailer +# identify image +cat image.jpg | httpthumbnailer-client + # thumbnail to standard output -cat ~/Pictures/compute.jpg | httpthumbnailer-client -t crop,100,200,png > thumbnail.png +cat image.jpg | httpthumbnailer-client -t crop,100,200,png > thumbnail.png # generate multiple thumbnails -cat ~/Pictures/compute.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,200,200,png thumbnail1.jpg thumbnail2.png +cat image.jpg | httpthumbnailer-client -t crop,100,200,jpeg,quality:100 -t pad,200,200,png thumbnail1.jpg thumbnail2.png ``` ## Contributing to HTTP Thubnailer Client * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet