Merge branch 'develop' into feature/#189

CONTRIBUTING.md → .github/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contribution Guidelines
 
-A more thorough set of contributing guidelines is fourthcoming, but here are the basics:
+A more thorough set of contributing guidelines is forthcoming, but here are the basics:
 
 * We welcome new contributors, but always review code.
 * Pull requests must address an issue in the issue tracker and be well-documented.

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,45 @@
+### This issue is a 
+
+bug / feature / question 
+
+<!-- Please leave only one -->
+
+### Steps to reproduce - current behaviour
+
+<!-- 
+  First, read https://github.com/subdavis/Tusk/wiki/Troubleshooting 
+  
+  If this issue is a bug, please explain what steps you took 
+  and how to reproduce your issue.
+  
+  For example: 
+  1. I open Tusk
+  1. I input the password
+  1. It doesn't unlock
+-->
+
+### What is the expected behaviour
+
+<!--
+  For example:
+  Please enable unlocking in Tusk!
+--> 
+
+#### Additional remarks
+
+<!-- This is optional --> 
+
+#### Environment 
+
+**Operating System:**
+
+**Browser:**
+
+**Storage:**
+
+<!-- 
+  For example: 
+  Operating System: macOS 10.XX.X / Windows 10 Pro
+  Browser: Chrome XX.XXX.XXX / Firefox XX.XXX
+  Storage: Nextcloud / Google Drive / Dropbox
+-->

README.md

@@ -1,7 +1,7 @@
 # Tusk
 > A modern, clean keepass browser extension built with Vue.js and kdbxweb.  Rebooted from perfectapi/CKP
 
-![Tusk](https://github.com/subdavis/Tusk/blob/develop/assets/icons/logo_256.png "Tusk Logo")
+![Tusk](https://user-images.githubusercontent.com/25948390/45255427-a466f300-b386-11e8-9321-931934faafb4.png "Tusk Logo")
 
 ## Installation
 
@@ -29,23 +29,20 @@ This section provides in-depth information about how tusk works under the hood.
 Tusk requires:
 * `node`
 * `npm`
-* `gulp`
 * `yarn`
 
 ```bash
 # install dependencies
 yarn install
 
-# Build static DLL resources
+# build static DLL resources (optional)
 yarn build-dll
 
-# static reload with file watch
-yarn watch
-
 # build for production with minification
 yarn build
 
-# run the packer script targeted for 'chrome' or 'firefox' after build
+# run the packer script targeted for 'chrome' and 'firefox' after build.
+# this step generates the zip archives submitted to Chrome/Firefox addon marketplaces.
 yarn bundle
 
 # build the tests
@@ -59,13 +56,13 @@ For detailed explanation on how things work, consult the [docs for vue-loader](h
 
 ## Running tests
 
-To run tests, first build them with `yarn build-tests` or `yarn watch-tests` then open `tests/test.html` in a browser.s
+To run tests, first build them with `yarn build-tests` or `yarn watch-tests` then open `tests/test.html` in a browser.
 
 ## Browser Permissions
 
 > Tusk requires cross-origin permissions in order to inject credentials and query the storage backends on the user's behalf.
 
-In chrome, these permissions requests are __always__ promted to the user upon first use.
+In chrome, these permissions requests are __always__ prompted to the user upon first use.
 
 Because of Firefox's implementation of `browser.permissions`, it was necessary to request all permissions at install time to avoid code rot.  A deeper explanation of the firefox permissions can be found [on stackoverflow](https://stackoverflow.com/questions/47723297/firefox-extension-api-permissions-request-may-only-be-called-from-a-user-input)
 
@@ -86,3 +83,7 @@ I don't want your money.  Take whatever you would have given me and find a local
 > So how can I support Tusk?
 
 If you ❤️ Tusk, please consider leaving a positive review on [the Firefox Add-on store](https://addons.mozilla.org/en-GB/firefox/addon/keepass-tusk/) or [the Chrome webstore](https://chrome.google.com/webstore/detail/fmhmiaejopepamlcjkncpgpdjichnecm) - I'll be eternally grateful.
+
+> Who made that awesome logo?
+
+A super cool artist and graphic designer named [Gabriel Garcia](https://github.com/ggabogarcia)!  Thanks for our logo!