Merge pull request #75 from doubleSlashde/feature/#73_update_readme_and_add_changelog

added Changelog and updated readme

* fixes #73

Author: Death111

CHANGELOG.md

@@ -0,0 +1,70 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+## v1.2.0 - yyyy-mm-dd
+
+### Added
+
+- search functionality
+- functionality to edit past work items
+- possibility to save position on screen
+- minutely auto-save to not lose work on crash
+- optional reminder for notes if switching projects without notes
+- shortcut for minimizing window (Win+Down)
+
+### Changed
+
+- hotkey popup has same functionality now as main project selection
+- removed old xml import feature
+- adapted report layout
+- the main ui is always on top
+- Icons changed
+
+### Fixed
+
+## v1.1.0 - 2019-07-15
+
+### Added
+
+Linux support (tested on Ubuntu 18.04), hot keys are disabled for Linux
+
+- about screen with licenses of third party software
+- colored time line to report screen
+- copy to clipboard button to report screen
+- convenient keyboard controls
+
+### Changed
+
+- new Font (OpenSans)
+
+### Fixed
+
+## v1.0.0 - 2018-10-28
+
+### Added
+
+- setting to prevent hiding the project list.
+
+### Changed
+
+- Decreased height of projects in list, so more projects fit in the same space
+- "Styled" settings window
+
+### Fixed
+
+- (workaround) 'stuck' key when using hotkeys and locking the pc
+
+## v1.0-beta.2 - 2018-09-25
+
+### Added
+
+- Import functionality for old config.xml
+- Database Migrations
+
+### Changed
+
+- Cleaning works from UI if the work is changed on another day
+- Moved db folder from user home/keeptime/db to ./db (relative to .jar like logs folder)
+
+### Fixed

README.md

@@ -1,23 +1,40 @@
 # KeepTime
+
 Application to track your time spent on different projects each day. Aim was to create an easy and fast way to track the doings over the day. In the end you get a summary for the day.
 
 Create projects and choose if they are counted as 'work time'. Select the project you work on. Before you switch the project, write a comment on what u did. Change the project. Repeat.
 
-Main view (when you hover over the app):\
-![Alt text](/readme/images/main.png?raw=true "Main")  
+## Usage
+
+### Main view:
+![Main Ui with description](readme/images/contextMenuDescription.png?raw=true "Main")  
 
 + You can move the window by dragging it around
-+ If you don't hover over the application the project list collapses
-+ Open the context menu for a project to edit/delete or change the project and transfer n minutes of the current running one
-+ You can change the project by clicking in the project list, or by using the Hotkey feature (if activated in settings) Strg+Win button. A popup will appear at the mouse cursor. With a mouseclick you have to first focus the app before you can make use of the search functionality. Up/Down will scroll through the projects and Enter will select the project.
++ Open the context menu (with a right-click) for a project to edit/delete or change the project and transfer n minutes of the current running one
 + In the taskbar you will also see the current time + the color of the active project
-+ You can choose the used colors for the main window, if the project list should be left or right and if you want to use the Hotkey
++ The current Project will be saved eyery minute to mitigate loss on system crash or shutdown without closing window manually first. 
 + After a day you can open the Reports, which will summarize the work done for the different projects during the day
 
-**You need to close the application manualy before you shutdown your PC. Otherwise the last running project is not saved to database.**
+**You need to close the application manualy before you shutdown your PC. Otherwise the last running project is not saved completely to database. (will be last state saved by auto-save)**
+
+### Settings:
+![Settings Screen](readme/images/settings.png?raw=true "Settings")
+
++ Colors: you can define various colors to use in the UI to customize the application. The Reset resets the color to the default color.
++ Display projects on the right: Will show the list of projects on the right side, instead of the left
++ Hide projects on mouse leave: If you don't hover over the application the project list collapses
++ Use Hotkey (`Strg`+`Win`): Change the project by using the Hotkey feature. A popup will appear at the mouse cursor.
++ Save Position on Screen: Remembers the last position of the Main UI on application start.
++ Ask for notes when switching project (if empty): Pops up a dialog to add notes if no notes are given and you try to switch projects
+
+### Reports:
+![Report Screen](readme/images/reportDescription.png?raw=true "Report")
 
-# Install
-* Download keeptime.bat and keeptime-1.1.0-SNAPSHOT-bin.zip (see [releases](https://github.com/doubleSlashde/KeepTime/releases))
++ the report screen gives you a summary for every day
+
+## Install
+
+* Download keeptime.bat and keeptime-<version>-bin.zip (see [releases](https://github.com/doubleSlashde/KeepTime/releases))
 * Extract the downloaded .zip
 * Copy the downloaded keeptime.bat file next to the *.jar*. Adapt the path inside the *keeptime.bat* to the name of the *.jar* file (if needed). Try starting the application by executing the *keeptime.bat* file. The start may take up to one minute.
 
@@ -27,11 +44,8 @@ It is recommended to run the application at computer start so you do not forget
 
 You should put the .jar in an extra folder as a *logs* and a *db* folder will be created next to it.\
 
-**migrate from old version**
-
-If you have a folder *db* next to the old .jar, the folder has to be next to the new .jar as well. The folder contains your tracked times.\
-If you used this application before with a *config.xml* you can import your old projects in the settings dialog. Place your config.xml next to the jar and press "parse config.xml". Otherwise no steps are needed.
 ## Requirements
+
 * Windows 7, 10
 * Linux (tested on Ubuntu 18.04)
 * Java 8 + JavaFX