From f498d7733034548dedc19044d94a616e479be89c Mon Sep 17 00:00:00 2001
From: Kevin Hendricks <kevinhendricks@users.noreply.github.com>
Date: Wed, 5 May 2021 17:38:49 -0400
Subject: [PATCH] update README and buildplugin script

---
 README.md        | 71 +++++++++---------------------------------------
 buildplugin      |  2 +-
 epubjs_README.md | 68 ++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 82 insertions(+), 59 deletions(-)
 create mode 100644 epubjs_README.md

diff --git a/README.md b/README.md
index a3959af..8223135 100644
--- a/README.md
+++ b/README.md
@@ -1,68 +1,23 @@
-Epub.js Reader
-================================
+**[Plugin] FuturePress EpubJSReader plugin for Sigil **
 
-![Demo](http://fchasen.com/futurepress/epubjs-reader_moby-dick.png)
+Updated: May 5, 2021
 
-[Try it while reading Moby Dick](http://futurepress.github.com/epubjs-reader/)
+Current Version: "0.1.0"
 
-About the Reader
--------------------------
+This plugin implements an epub3 reader for the epub currently being edited in Sigil.
+It uses PyQt5 and PyQtWebengine to create a browser like main window and then loads
+FuturePress's EpubJS epub reader project to implement the epub reader.
 
-[Epub.js](http://futurepress.github.com/epub.js/) library.
+See https://github.com/futurepress/epub.js/
+    https://github.com/futurepress/epubjs-reader/
 
+License/Copying: The EpubJS Reader code is covered by its own MIT License.
 
-Getting Started
--------------------------
+License/Copying: The actual python code used to create this plugin is covered under the GNU LGPL Version 2 or Version 3, your choice.  Any other license terms are only available directly from the authors of Sigil in writing.
 
-Open up [reader/index.html](http://futurepress.github.com/epubjs-reader/index.html) in a browser.
+Minimum Sigil Version: support for this plugin is provided for Sigil 1.6.0 and later using the Python 3.6 or later Python interpreter.
 
-You can change the ePub it opens by passing a link to bookPath in the url:
 
-`?bookPath=https://s3.amazonaws.com/epubjs/books/alice.epub`
+See the Sigil Plugin Index on MobileRead to find out more about this plugin and other plugins available for Sigil:
+https://www.mobileread.com/forums/showthread.php?t=247431
 
-Running Locally
--------------------------
-
-Install [node.js](http://nodejs.org/)
-
-Then install the project dependences with npm
-
-```javascript
-npm install
-```
-
-You can run the reader locally with the command
-
-```javascript
-node start
-```
-
-Builds are concatenated and minified using [gruntjs](http://gruntjs.com/getting-started)
-
-To generate a new build run
-
-```javascript
-grunt
-```
-
-Or, to generate builds as you make changes run
-
-```
-grunt watch
-```
-
-Additional Resources
--------------------------
-
-[Epub.js Developer Mailing List](https://groups.google.com/forum/#!forum/epubjs)
-
-IRC Server: freenode.net Channel: #epub.js
-
-Follow us on twitter: @Epubjs
-
-+ http://twitter.com/#!/Epubjs
-
-Other
--------------------------
-
-EPUB is a registered trademark of the [IDPF](http://idpf.org/).
diff --git a/buildplugin b/buildplugin
index 775c90d..e213aa4 100755
--- a/buildplugin
+++ b/buildplugin
@@ -22,7 +22,7 @@ PLUGIN_FILES = ['reader',
             'reader_demo_v3.py',
             'ChangeLog.txt',
             'epub_js_license.txt',
-            'README.md',
+            'epubjs_README.md',
             'plugin.py',
             'plugin.xml',]
 
diff --git a/epubjs_README.md b/epubjs_README.md
new file mode 100644
index 0000000..a3959af
--- /dev/null
+++ b/epubjs_README.md
@@ -0,0 +1,68 @@
+Epub.js Reader
+================================
+
+![Demo](http://fchasen.com/futurepress/epubjs-reader_moby-dick.png)
+
+[Try it while reading Moby Dick](http://futurepress.github.com/epubjs-reader/)
+
+About the Reader
+-------------------------
+
+[Epub.js](http://futurepress.github.com/epub.js/) library.
+
+
+Getting Started
+-------------------------
+
+Open up [reader/index.html](http://futurepress.github.com/epubjs-reader/index.html) in a browser.
+
+You can change the ePub it opens by passing a link to bookPath in the url:
+
+`?bookPath=https://s3.amazonaws.com/epubjs/books/alice.epub`
+
+Running Locally
+-------------------------
+
+Install [node.js](http://nodejs.org/)
+
+Then install the project dependences with npm
+
+```javascript
+npm install
+```
+
+You can run the reader locally with the command
+
+```javascript
+node start
+```
+
+Builds are concatenated and minified using [gruntjs](http://gruntjs.com/getting-started)
+
+To generate a new build run
+
+```javascript
+grunt
+```
+
+Or, to generate builds as you make changes run
+
+```
+grunt watch
+```
+
+Additional Resources
+-------------------------
+
+[Epub.js Developer Mailing List](https://groups.google.com/forum/#!forum/epubjs)
+
+IRC Server: freenode.net Channel: #epub.js
+
+Follow us on twitter: @Epubjs
+
++ http://twitter.com/#!/Epubjs
+
+Other
+-------------------------
+
+EPUB is a registered trademark of the [IDPF](http://idpf.org/).