diff --git a/Readme.md b/Readme.md new file mode 100644 index 0000000000..02f076475a --- /dev/null +++ b/Readme.md @@ -0,0 +1,26 @@ + ============================================= + === pdf.js Viewer Plugin + === A pdf.js-based PDF viewer for OJS 3.0.x + === Author: Alec Smecher + ============================================= + +## About + +This is a PDF viewer plugin based on the pdf.js PDF reader. + +## License + +This plugin is licensed under the GNU General Public License v2. See the file LICENSE for the complete terms +of this license. + +## Installation + +To install this plugin, place its files into a subdirectory of `plugins/viewableFiles` called pdfJsViewer. +Run the upgrade script (please back up your database before doing this) to register the plugin with your +installation of OJS. + +Once the plugin has been installed, use the Journal Manager's "Plugins" interface to enable it. + +## Contact/Support + +Please email the authors for support, bugfixes, or comments.