update readme

README.md

@@ -1,30 +1,19 @@
-# electron-react
+# BloomPUB Viewer
 
-> An electron-react project
+> A desktop viewer for bloomPUB books
 
-#### Build Setup
+#### Building
 
-``` bash
+```bash
 # install dependencies
-npm install
-
-# serve with hot reload at localhost:9080
-npm run dev
-
-# build electron application for production
-npm run build
-
-# run tests
-npm test
-
-
-# lint all files in `src/`
-npm run lint
+yarn
 
+# serve with hot reload
+yarn dev
 ```
 
----
-
-This project was generated by [create-electron-react](zenghongtu/create-electron-react), inspired by [electron-react](https://github.com/SimulatedGREG/electron-vue).
+# Releasing
 
-Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).
+1. Update the version in package.json
+1. Add a tag to commit and push it
+1. `yarn release` will create a draft release on github with the windows exe. Add in any description and publish it.

package.json

@@ -1,5 +1,5 @@
 {
-  "name": "bloom-viewer",
+  "name": "bloompub-viewer",
   "version": "0.2.0",
   "author": "Bloom Devs",
   "description": "Viewer for Bloom Digital books",
@@ -24,7 +24,7 @@
     "test:e2e": "yarn run pack && jest -c jest.e2e.config.js"
   },
   "build": {
-    "productName": "BloomPub Viewer",
+    "productName": "BloomPUB Viewer",
     "appId": "org.sil.bloompub-viewer",
     "directories": {
       "output": "output"
@@ -41,12 +41,12 @@
       "fileAssociations": [
         {
           "ext": "bloomd",
-          "name": "BloomPub File",
+          "name": "BloomPUB File",
           "role": "Viewer"
         },
         {
           "ext": "bloompub",
-          "name": "BloomPub File",
+          "name": "BloomPUB File",
           "role": "Viewer"
         }
       ]