-# pdf.js
+# PDF.JS
-
-## Overview
-
pdf.js is an HTML5 technology experiment that explores building a faithful
and efficient Portable Document Format (PDF) renderer without native code
assistance.
-## Getting started
+# Getting started
### Online demo
### Extension
-An up-to-date Firefox extension is also available:
+A Firefox extension is also available:
+ http://mozilla.github.com/pdf.js/extensions/firefox/pdf.js.xpi
-(The above link is updated upon every merge to our master branch).
+Note that this extension is self-updating, and by default Firefox will auto-update extensions on a
+daily basis (you can change this through the `extensions.update.interval` option in `about:config`).
For an experimental Chrome extension, get the code as explained below and issue `make extension`.
Then open Chrome with the flag `--enable-experimental-extension-apis`, go to `Tools > Extension`
This will generate the file `build/pdf.js` that can be included in your final project. (WARNING: That's a large file! Consider minifying it).
-## Learning
+# Learning
Here are some initial pointers to help contributors get off the ground.
Additional resources are available in a separate section below.
-#### Hello world
+### Hello world
For a "hello world" example, take a look at:
This example illustrates the bare minimum ingredients for integrating pdf.js
in a custom project.
-#### Introductory video
+### Introductory video
Check out the presentation by our contributor Julian Viereck on the inner
workings of PDF and pdf.js:
-## Contributing
+# Contributing
pdf.js is a community-driven project, so contributors are always welcome.
Simply fork our repo and contribute away. Good starting places for picking
-## Running the tests
+# Running the tests
pdf.js comes with browser-level regression tests that allow one to probe
whether it's able to successfully parse PDFs, as well as compare its output
raising any errors.
-## Running tests through our bot
+### Running tests through our bot
If you are a reviewer, you can use our remote bot to issue comprehensive tests
against reference images before merging pull requests.
+ https://github.com/mozilla/pdf.js-bot
-## Additional resources
+# Additional resources
Gallery of user projects and modifications:
-## PDF-related resources
+### PDF-related resources
A really basic overview of PDF is described here: