Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README.md #1

Merged
merged 1 commit into from
Mar 22, 2013
Merged

Update README.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# open-thumbnailer

##Overview
A friendly node.js (www.nodejs.org) JavaScript wrapper around phantomjs (http://phantomjs.org/) that lets you create webpage thumbnails in a headless environment with a few lines of code. There are generally several things you want to do when creating a thumbnail:
A friendly [node.js](www.nodejs.org) JavaScript wrapper around [phantomjs](http://phantomjs.org/) that lets you create webpage thumbnails in a headless environment with a few lines of code. There are generally several things you want to do when creating a thumbnail:

- Render the webpage as a PNG or JPG
- Control the quality level of your saved thumbnail (for JPGs)
Expand All @@ -14,7 +14,7 @@ The open-thumbnailer library makes all of this very easy.
##Installation
`npm install open-thumbnailer`

To use a lot of the functionality in the library you will need to install graphicsmagick (http://www.graphicsmagick.org) as well.
To use a lot of the functionality in the library you will need to install [graphicsmagick](http://www.graphicsmagick.org) as well.

##Examples Thumbnails
Here are some example thumbnails generated by this library:
Expand Down