Readying release

Author: bengourley

ISSUE_TEMPLATE.md

@@ -0,0 +1,18 @@
+### Expected behavior
+*[Insert details on expected behaviour]*
+
+### Observed behavior
+*[Insert details on observed behaviour]*
+
+### Steps to reproduce
+*[Insert reproduction steps (if known)]*
+
+### Version
+*[Insert version information]*
+
+### Additional information
+*[Insert any additional information]*
+
+#### Can't comment on Issues?
+Some users have been unable to comment on Github issues when an [adblocker extension is enabled](https://docs.bugsnag.com/platforms/browsers/faq/#is-bugsnag-blocked-by-ad-blockers).
+We recommend temporarily disabling the extension, or if that fails, contacting support@bugsnag.com.

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2017 Bugsnag, https://bugsnag.com/
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the Software
+is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -2,22 +2,48 @@
 
 A [bugsnag-js](https://github.com/bugsnag/bugsnag-js) plugin for [Vue.js](https://vuejs.org/).
 
+This package enables you to integrate Bugsnag's error reporting with a Vue.js application at a detailed level. It creates and configures a Vue `ErrorHandler` which will capture and report unhandled errors in your app.
+
+Reported errors will contain useful debugging info from Vue's internals, such as the component name, props and any other context that Vue can provide.
+
+## Installation
+
+You can opt to install the package from npm, using the instructions below. Alternatively you can load the plugin from our CDN via a `<script/>` tag.
+
+### CDN
+
+```html
+<script src="//d2wy8f7a9ursnm.cloudfront.net/bugsnag-plugins/bugsnag-vue/v1/bugsnag-vue.min.js"></script>
+```
+
+### npm
+
+```sh
+npm i --save bugsnag-js bugsnag-vue
+# or
+yarn add bugsnag-js bugsnag-vue
+```
+
 ## Usage
 
-### Inline
+Depending on how your application is structured, usage differs slightly:
+
+### Inline script tag
+
+The script tag creates a global function called `bugsnag__vue` which needs to be passed a reference to the Vue object. Ensure that Vue is loaded/available before calling this function.
 
 ```html
-<script src="https://unpkg.com/vue"></script>
-<script src="//d2wy8f7a9ursnm.cloudfront.net/4.x.x/bugsnag.min.js"></script>
-<script src="//d2wy8f7a9ursnm.cloudfront.net/bugsnag-plugin-vue/1.x.x/bugsnag-vue.min.js"></script>
 <script>
   window.bugsnagClient = bugsnag('API_KEY')
+  // after Vue has been loaded…
   bugsnagClient.use(bugsnag__vue(Vue))
 </script>
 ```
 
 ### Bundled
 
+If you installed the package from npm, usage will look more like the following snippet. Again, ensure you have a reference to `Vue` before you create the plugin.
+
 ```js
 const Vue = require('vue')
 const bugsnag = require('bugsnag-js')
@@ -26,3 +52,13 @@ const bugsnagVue = require('bugsnag-vue')
 const bugsnagClient = bugsnag('API_KEY')
 bugsnagClient.use(bugsnagVue(Vue))
 ```
+
+## Support
+
+* Check out the [documentation](https://docs.bugsnag.com/platforms/browsers/)
+* [Search open and closed issues](https://github.com/bugsnag/bugsnag-react/issues?q=is%3Aissue) for similar problems
+* [Report a bug or request a feature](https://github.com/bugsnag/bugsnag-react/issues/new)
+
+## License
+
+The Bugsnag JS library and official plugins are free software released under the MIT License. See [LICENSE.txt](LICENSE.txt) for details.