Better document the package

[kenperkins]

This library would benefit from some documentation above the usage in test/_index.coffee

[somentelucas]

agreed

[soichih]

I have no idea how to run this.. Can you document?

[gasi]

@soichih Does this example help?

node-deepzoomtools/test/index._coffee

Lines 39 to 50 in 331d6da

	# Create pyramid
	ID = Math.floor Math.random() * 1000
	SOURCE = path.join __dirname, 'images', 'carina-nebula-6000x2906.jpg'
	DESTINATION = path.join __dirname, 'images', "#{ID}.dzi"
	DEFAULT_TILE_SIZE = 254
	DEFAULT_TILE_OVERLAP = 1
	DEFAULT_FORMAT = 'jpg'
	DeepZoomImage.create _, SOURCE, DESTINATION, DEFAULT_TILE_SIZE,
	DEFAULT_TILE_OVERLAP, DEFAULT_FORMAT

[soichih]

@gasi Yes, I think it will be nice if it's explained on the README.md. Also, can you post it in a plain Javascript?

[gasi]

@soichih I am currently not maintaining this library, but feel free to submit a PR and I’d be happy to review and merge. Thanks for your understanding 😄