Permalink
Browse files

readme update

  • Loading branch information...
1 parent 1a15c50 commit 3d46382585d0b29b27d8010db89213b6c1064a2b @pdfcrowd committed Apr 28, 2011
Showing with 7 additions and 7 deletions.
  1. +7 −7 README.md
View
14 README.md
@@ -35,7 +35,7 @@ The following code converts raw HTML code to PDF and sends it as a response:
myPdfcrowd.convertHtml('<html>...</html>');
-You can convert also a webpage:
+You can convert also a web page:
myPdfcrowd.convertURI('http://example.com');
@@ -60,7 +60,7 @@ The generated PDF can be customized:
### Construction
-#### new Pdfcrowd(username, apikey);
+ new Pdfcrowd(username, apikey);
Creates a Pdfcrowd instance.
@@ -71,26 +71,26 @@ lets you customize the created PDF. You can find the list of all
options
[here](http://pdfcrowd.com/html-to-pdf-api/#api-ref-conversion-common-par).
-#### Pdfcrowd.convertHtml(html [,options]);
+ Pdfcrowd.convertHtml(html [,options]);
Convert raw HTML code to PDF.
-#### Pdfcrowd.convertURI(url [,options]);
+ Pdfcrowd.convertURI(url [,options]);
Convert a web page to PDF. The *url* argument must start with http:// or https://.
-#### Pdfcrowd.convertFile(fname [,options]);
+ Pdfcrowd.convertFile(fname [,options]);
Convert a local HTML file to PDF.
### Callbacks
-#### Pdfcrowd.on('pdf', function([readableStream](http://nodejs.org/docs/latest/api/streams.html#readable_Stream)){});
+ Pdfcrowd.on('pdf', function([readableStream](http://nodejs.org/docs/latest/api/streams.html#readable_Stream)){});
Called when the PDF stream becomes available.
-#### Pdfcrowd.on('error', function(errorMsg, statusCode){});
+ Pdfcrowd.on('error', function(errorMsg, statusCode){});
Called when an error occurs. *errorMsg* is an string containing the
error message and *statusCode* is a HTTP status code.

0 comments on commit 3d46382

Please sign in to comment.