Update Readme and Changelog

CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+- *nothing*
+
+## [1.0.0] - 2017-09-12
+### Added
+- Importing
+- Support for Excel import/export
+- Better feedback on import/export
+- Option to export without showing a dialog
+
+## Changed
+- New UI in a separate window
+
+
+[Unreleased]: https://github.com/andburn/hdt-plugin-endgame/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/andburn/hdt-plugin-endgameg/compare/v0.3.1...v1.0.0
+
+
+---
+
+*The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)*

README.md

@@ -1,33 +1,47 @@
 # Stats Converter
 [![GitHub release](https://img.shields.io/github/release/andburn/hdt-plugin-statsconverter.svg?maxAge=604800)](https://github.com/andburn/hdt-plugin-statsconverter/releases/latest)
 [![Github Releases](https://img.shields.io/github/downloads/andburn/hdt-plugin-statsconverter/latest/total.svg?maxAge=604800)](https://github.com/andburn/hdt-plugin-statsconverter/releases/latest)
+[![codecov](https://codecov.io/gh/andburn/hdt-plugin-statsconverter/branch/master/graph/badge.svg)](https://codecov.io/gh/andburn/hdt-plugin-statsconverter)
 
-A plugin to ~~import and~~ export game statistics from [Hearthstone Deck Tracker](https://github.com/HearthSim/Hearthstone-Deck-Tracker).
+A plugin to import and export game statistics from [Hearthstone Deck Tracker](https://github.com/HearthSim/Hearthstone-Deck-Tracker).
 
-## Installation
-1. Delete any previous releases
-- Then unzip the [latest release](https://github.com/andburn/hdt-plugin-statsconverter/releases/latest) into the HDT Plugins directory (this directory can be opened with `options > plugins > plugins folder` button)
-- The directory should look like ``Plugins/StatsConverter/[some files]``
-- Enable the plugin from ``Options/Plugins`` menu
-- Use to the *export*, *import* and *settings* options from the plugins menu as shown below:
-![Menu](http://i.imgur.com/HIrkY6T.png)
+---
 
-## Supported Formats
-There are limited amount of available formats at the moment:
+## Install
+- Download the [latest release](https://github.com/andburn/hdt-plugin-endgame/releases/latest) (*not the source code*)
+- Unzip the contents into you Hearthstone Deck Tracker's plugins folder (or drag-and-drop onto the plugin menu)
+- Enable the plugin in HDT's settings
+- Use the plugin [settings](#settings) to customize it's behaviour
 
-### Export
-- CSV (Column Separated Values) format
- - When *Arena* mode is selected, mark the *Arena Extras* check box to export an additional file containing arena deck and reward data.
+## Features
 
-   ![Imgur](http://i.imgur.com/VeREf1l.png)
+Allows exporting and importing game statistics from [Hearthstone Deck Tracker](https://github.com/HearthSim/Hearthstone-Deck-Tracker). Two formats are currently supported CSV (*Comma Separated Values*) and Excel. Exporting enables players to analyse their statistics outside of HDT. Importing allows new games to be added and existing games edited, see [note](#importing) about importing below.
 
-### Import
-- (Not Available)
+![Menu](Docs/export.png)
 
-## Development
-- To build the plugin the project dependencies need to be added manually.
-- Add references (see [plugin-example](https://github.com/andburn/hdt-plugin-example/blob/master/README.md) for details) to the following files in your HDT installation:
- - `HearthstoneDeckTracker.exe`
- - `MahApps.Metro.dll`
- - `Newtonsoft.Json.dll`
-- It is also a good idea to set the *Copy Local* property of this references to *False*.
+## Usage
+The plugins menu opens the main converter window. Select one of the import, export or settings buttons as required.
+
+![Menu](Docs/menu.png)
+
+### Settings
+The settings page allows you to change how the plugin behaves.
+
+![settings](Docs/settings.png)
+
+- **Filename prefix**, the name to give any exported stats files.
+- **Add timestamp**, add the date and time to the filename of exported stats.
+- **Export to**, set the default export directory.
+- **No Export Dialog**, do not show a file save dialog when exporting, use the directory specified in '*Export to*' (*Desktop* by default).
+- **Show Import Warning**, shows the warning message on the import page.
+
+## Importing
+Extra care must be taken when importing statistics, you should always check that the importing process has worked as expected by inspecting the stats in HDT. If you need to revert an import restore the most recent backup found in the HDT options.
+
+Importing is mainly intended for editing existing statistics using data previously exported by this plugin. Creating statistics files manually and importing them, for adding new games for example, should work but care should be taken that the format is correct.
+
+## License
+The plugin is licensed under the terms of the MIT license. The full license text is available in the LICENSE file.
+
+## Attribution
+This plugin uses [IcoMoon](https://icomoon.io/) free font icons licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)