Merge pull request #4 from doubleSlashde/feature/readme

Feature/readme

Author: Death111

README.md

@@ -1 +1,41 @@
 # KeepTime
+Readme is WIP\
+Project is Beta\
+You will most probably have to reconfigure the application with your details if a newer version will appear.\
+
+# Use
+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")  
+You can move the window by dragging it around.
+
+If you don't hover over the application the project list collapses:\
+![Alt text](/readme/images/standby.png?raw=true "Standby")
+
+Open the context menu for a project to edit/delete or change the project and transfer n minutes of the current running one\
+![Alt text](/readme/images/contextMenu.png?raw=true "contextMenu")
+
+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.\
+![Alt text](/readme/images/popup.png?raw=true "popup")
+
+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\
+![Alt text](/readme/images/settings.png?raw=true "settings")
+
+After a day you can open the Reports, which will summarize the work done for the different projects during the day\
+![Alt text](/readme/images/report.png?raw=true "report")
+
+In the taskbar you will also see the current time + the color of the active project:\
+![Alt text](/readme/images/taskbar.png?raw=true "taskbar")
+
+
+**You need to close the application manualy before you shutdown your PC. Otherwise the last running project is not saved to database.**
+
+# Install
+Download and execute .jar file (TBD). You should put the .jar in an extra folder as a *logs* folder will be created next to it.\
+You can put the .jar in the autostart folder
+
+## Requirements
+Only works correct for windows currently. Tested on 7 and 10.