diff --git a/README.md b/README.md index c57d434..a69cbe5 100644 --- a/README.md +++ b/README.md @@ -62,56 +62,56 @@ Installation uses the [npm](http://npmjs.org/) package manager. Just type the f ## Example -```coffeescript -PDFDocument = require 'pdfkit' +```javascript +const PDFDocument = require('pdfkit'); -# Create a document -doc = new PDFDocument +// Create a document +const doc = new PDFDocument; -# Pipe its output somewhere, like to a file or HTTP response -# See below for browser usage -doc.pipe fs.createWriteStream('output.pdf') +// Pipe its output somewhere, like to a file or HTTP response +// See below for browser usage +doc.pipe(fs.createWriteStream('output.pdf')); -# Embed a font, set the font size, and render some text +// Embed a font, set the font size, and render some text doc.font('fonts/PalatinoBold.ttf') .fontSize(25) - .text('Some text with an embedded font!', 100, 100) + .text('Some text with an embedded font!', 100, 100); -# Add an image, constrain it to a given size, and center it vertically and horizontally +// Add an image, constrain it to a given size, and center it vertically and horizontally doc.image('path/to/image.png', { fit: [250, 300], align: 'center', valign: 'center' }); -# Add another page +// Add another page doc.addPage() .fontSize(25) - .text('Here is some vector graphics...', 100, 100) + .text('Here is some vector graphics...', 100, 100); -# Draw a triangle +// Draw a triangle doc.save() .moveTo(100, 150) .lineTo(100, 250) .lineTo(200, 250) - .fill("#FF3300") + .fill("#FF3300"); -# Apply some transforms and render an SVG path with the 'even-odd' fill rule +// Apply some transforms and render an SVG path with the 'even-odd' fill rule doc.scale(0.6) .translate(470, -380) .path('M 250,75 L 323,301 131,161 369,161 177,301 z') .fill('red', 'even-odd') - .restore() + .restore(); -# Add some text with annotations +// Add some text with annotations doc.addPage() .fillColor("blue") .text('Here is a link!', 100, 100) - .underline(100, 100, 160, 27, color: "#0000FF") - .link(100, 100, 160, 27, 'http://google.com/') + .underline(100, 100, 160, 27, {color: "#0000FF"}) + .link(100, 100, 160, 27, 'http://google.com/'); -# Finalize PDF file -doc.end() +// Finalize PDF file +doc.end(); ``` [The PDF output from this example](http://pdfkit.org/demo/out.pdf) (with a few additions) shows the power of PDFKit — producing @@ -133,28 +133,29 @@ module. The following example uses Browserify to load `PDFKit` and `blob-stream`, but if you're not using Browserify, you can load them in whatever way you'd like (e.g. script tags). -```coffeescript -# require dependencies -PDFDocument = require 'pdfkit' -blobStream = require 'blob-stream' +```javascript +// require dependencies +const PDFDocument = require('pdfkit'); +const blobStream = require('blob-stream'); -# create a document the same way as above -doc = new PDFDocument +// create a document the same way as above +const doc = new PDFDocument; -# pipe the document to a blob -stream = doc.pipe(blobStream()) +// pipe the document to a blob +const stream = doc.pipe(blobStream()); -# add your content to the document here, as usual +// add your content to the document here, as usual -# get a blob when you're done -doc.end() -stream.on 'finish', -> - # get a blob you can do whatever you like with - blob = stream.toBlob('application/pdf') +// get a blob when you're done +doc.end(); +stream.on('finish', function() { + // get a blob you can do whatever you like with + const blob = stream.toBlob('application/pdf'); - # or get a blob URL for display in the browser - url = stream.toBlobURL('application/pdf') - iframe.src = url + // or get a blob URL for display in the browser + const url = stream.toBlobURL('application/pdf'); + iframe.src = url; +}); ``` You can see an interactive in-browser demo of PDFKit [here](http://pdfkit.org/demo/browser.html).