Skip to content

Commit

Permalink
Add documentation and prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
shivaprsd committed Oct 30, 2022
1 parent 2092647 commit 02b7aa4
Show file tree
Hide file tree
Showing 7 changed files with 15 additions and 3 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
change the PDF's colors) on top, packaged as an extension for Firefox. It
replaces the built-in PDF.js viewer as the default PDF viewer application.

It also adds some other features like Smart Zoom text and Show/Hide toolbar to
optimize space and assist reading, especially on smaller devices.

Here is the demo PDF rendered in *Solarized Light* theme:

![Screenshot of doqment running in Firefox](docs/grabs/solarized-light.png)
Expand Down
9 changes: 9 additions & 0 deletions docs/gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,15 @@

![Screenshot of the reader mode toolbar](grabs/reader-toolbar.png)

### Smart Zoom with Hidden Toolbar

![PDF in sepia theme, with hidden toolbar and zoomed column of text](grabs/smart-zoom.png)
_Also showing Original Link popup button._

### Smart Zoom on Mobile

![PDF in dark theme, in a narrow mobile screen, demoing smart zoom](grabs/smart-zoom-mobile.gif)

## Themes

### Nord
Expand Down
Binary file added docs/grabs/smart-zoom-mobile.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/grabs/smart-zoom.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "doqment",
"version": "0.2",
"version": "0.3",
"description": "Mozilla's HTML5 PDF Viewer with Reader-mode add-on.",
"homepage": "https://github.com/shivaprsd/doqment",
"repository": "github:shivaprsd/doqment",
Expand Down
2 changes: 1 addition & 1 deletion src/doq
Submodule doq updated 2 files
+12 −0 CHANGELOG.md
+2 −2 package.json
2 changes: 1 addition & 1 deletion src/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"manifest_version": 2,
"version": "0.2",
"version": "0.3",

"name": "doqment PDF Reader",
"short_name": "doqment",
Expand Down

0 comments on commit 02b7aa4

Please sign in to comment.