Update README

Author: Dansoftowner

.gitignore

@@ -1,3 +1,4 @@
 build
 .idea
-.nb-gradle
+.nb-gradle
+out

README.md

@@ -1,48 +1,117 @@
 # JavaFXTaskbarProgressBar
-## This library allows you to add taskbar progressbars to your javafx stages.
-The library uses another library called [Bridj](https://github.com/nativelibs4java/BridJ). 
-With the Bridj library you can add taskbar progressbars only to the old swing JFrames, 
-but not for your javafx stages. But this library will be your solution i hope :).
+## This library allows you to add native taskbar-progressbar functionality to your JavaFX stages.
+The library uses another library called [bridj](https://github.com/nativelibs4java/BridJ) that 
+can give access to native operations in java. With the Bridj library you can easily add taskbar progressbars 
+to the old swing JFrames but for javafx stages it's too complicated to achieve.<br> 
+<b>This library is for you who want to easily use this amazing native functionality with JavaFX!</b>
+
+## Compatibility
+This library only works with java 8 but java 11 support is coming soon!
+
+## Background: what are taskbar progressbars?
+Since Windows 7 there is a taskbar-progressbar feature in Windows systems.
+A good example for this when you copy something using the file explorer:<br>
+![Taskbar progressbar in windows 7](images/areo-progressbar.jpg) <br>
+This library allows you to do this in java (with javaFX)!
 
 ## How to include it to your project
 You can download the jar file from the releases.
+Every release has two jar files: one is a fat jar that contains the bridj binaries 
+as well (so if you use this you don't have to include bridj separately for your project);
+and another jar that doesn't contain the external bridj binaries (in this case you have
+to download it separately).
 
-## How to use it
+## How to use it in practice
 
-Create your stage:
-```java
-Stage stage = new Stage();
-```
+### Types of progressbar
+Before we jump in we have to know the 4 types of a taskbar-progressbar:<br>
+* `NORMAL` - a progressbar with normal green color
+* `PAUSED` - a progressbar with a yellow color
+* `ERROR`  - a progressbar with a red color 
+* `INDETERMINATE` - a progressbar that doesn't show any fix progress
+* `NO_PROGRESS` - a progressbar that doesn't show anything 
+<br><br>
+All these types are represented by an enum called `com.nativejavafx.taskbar.TaskbarProgressbar.Type`.
+
+Now let's see how can we actually use this through code.<br>
+There are multiple ways to create taskbar progressbars with this library:
 
-Then, you have to create the TaskbarProgressbar object:
+#### Static methods
+Firstly you have to import the necessary class:
 ```java
-TaskbarProgressbar taskProgressbar = new TaskbarProgressbar(stage);
+import com.nativejavafx.taskbar.TaskbarProgressbar; 
+```
+...and you have to show the javafx Stage before any operation:
 ```
-Before you start the taskbar progressbar, you must show the stage
+primaryStage.show();
+``` 
+Then call the static method:
 ```java
-stage.show();
+TaskbarProgressbar.showCustomProgress(primaryStage, 50, 100, TaskbarProgressbar.Type.NORMAL);
 ```
-Now you can do everything that the taskbar progressbar can do, for example you can show a progress:
+
+It looks okay but it's not safe to do that. This functionality isn't supported by every OS.
+<b>If you use this way to create taskbar progressbars you always have to check that the current OS 
+supports this functionality!</b> 
+
+So let's correct the code:
 ```java
-taskProgressbar.showOtherProgress(50, 100, TaskbarProgressbar.TaskbarProgressbarType.NORMAL);
+if (TaskbarProgressbar.isSupported()) {
+    TaskbarProgressbar.showCustomProgress(primaryStage, 50, 100, TaskbarProgressbar.Type.NORMAL);
+}
 ```
-It will creates this view at the taskbar:
-![](https://i.stack.imgur.com/IG7v5.png).
 
-There are 5 types of the taskbar progressbar: 
+<b>Result:</b><br>
+![Normal Taskbar progressbar](images/normal-progress.jpg)
 
-`TaskbarProgressbar.TaskbarProgressbarType.NORMAL` - It is the normal progressbar with the green color
-`TaskbarProgressbar.TaskbarProgressbarType.ERROR` - It is the error progressbar with the red color.
-`TaskbarProgressbar.TaskbarProgressbarType.PAUSED` - It is the paused progressbar with the yellow color.
+You have to do a similar thing if you want to show an indeterminate progress:
+```java
+if (TaskbarProgressbar.isSupported()) {
+    TaskbarProgressbar.showIndeterminateProgress(primaryStage);
+}
+```
+<b>Result:</b><br>
+![Indeterminate Taskbar progressbar](images/indeterminate.gif)
 
-`TaskbarProgressbar.TaskbarProgressbarType.NO_PROGRESS` - It is the empty progressbar
-`TaskbarProgressbar.TaskbarProgressbarType.INDETERMINATE` - It is the indeterminate progressbar. It doesn't show any fix progress.
+To stop the progress:
+```java
+TaskbarProgressbar.stopProgress(primaryStage);
+```
+#### Through instantiation
+Firstly (after you imported the necessary class) create a `TaskbarProgressbar` instance:
+```java
+TaskbarProgressbar progressbar = TaskbarProgressbar.createInstance(primaryStage);
+```
+Before any operation you have to show the Stage:
+```java
+primaryStage.show();
+```
+After that just use the created instance for the operations:
+```
+progressbar.showCustomProgress(50, 100, TaskbarProgressbar.Type.NORMAL);
+```
+<b><i>Note: in this case to check that the OS supports this functionality is unnecessary
+because the object checks it automatically!</i></b>
+
+The result is the same:<br>
+![Normal Taskbar progressbar](images/normal-progress.jpg)
 
-If you want to show an indeterminate progress:
+If you want an indeterminate process:
 ```java
-taskbarProgressbar.showIndeterminateProgress();
+progressbar.showIndeterminateProgress();
 ```
-If you want to stop the progress:
+To stop the progress:
 ```java
-taskbarProgressbar.stopProgress();
+progressbar.stopProgress();
 ```
+#### Full example
+
+
+## More screenshots
+Some more screenshots about what can you do with this library
+* A paused progress example:<br>
+Code: `progressbar.showCustomProgress(70, 100, TaskbarProgressbar.Type.PAUSED);`<br>
+![Paused progress](images/paused-progress.jpg)
+* An error progress example:<br>
+Code: `progressbar.showCustomProgress(40, 100, TaskbarProgressbar.Type.ERROR);`<br>
+![Paused progress](images/error-progress.jpg)

images/areo-progressbar.jpg

@@ -14,7 +14,7 @@ public void showIndeterminateProgress() {
     }
 
     @Override
-    public void showCustomProgress(long done, long max, TaskbarProgressbarType type) {
+    public void showCustomProgress(long done, long max, Type type) {
     }
 
     @Override

images/error-progress.jpg

@@ -19,7 +19,7 @@ public abstract class TaskbarProgressbar {
      * Defines the types of the taskbar progressbars
      * that can be used on a Windows 7+ system.
      */
-    public enum TaskbarProgressbarType {
+    public enum Type {
         ERROR(ITaskbarList3.TbpFlag.TBPF_ERROR),
         INDETERMINATE(ITaskbarList3.TbpFlag.TBPF_INDETERMINATE),
         NO_PROGRESS(ITaskbarList3.TbpFlag.TBPF_NOPROGRESS),
@@ -28,7 +28,7 @@ public enum TaskbarProgressbarType {
 
         private final ITaskbarList3.TbpFlag bridjPair;
 
-        TaskbarProgressbarType(ITaskbarList3.TbpFlag bridjPair) {
+        Type(ITaskbarList3.TbpFlag bridjPair) {
             this.bridjPair = bridjPair;
         }
 
@@ -55,13 +55,13 @@ public ITaskbarList3.TbpFlag getBridjPair() {
      * @param type the type of the progress; must't be null
      * @throws NullPointerException if the type is null
      */
-    public abstract void showCustomProgress(long done, long max, TaskbarProgressbarType type);
+    public abstract void showCustomProgress(long done, long max, Type type);
 
     /**
      * Shows a 100% error progress
      */
     public void showFullErrorProgress() {
-        this.showCustomProgress(100, 100, TaskbarProgressbarType.ERROR);
+        this.showCustomProgress(100, 100, Type.ERROR);
     }
 
 
@@ -119,17 +119,17 @@ public static void showIndeterminateProgress(Stage stage) {
      * Shows a custom progress on the taskbar.
      *
      * <p><br>
-     * Actually calls the {@link TaskbarProgressbar#showCustomProgress(int, long, long, TaskbarProgressbarType)}
+     * Actually calls the {@link TaskbarProgressbar#showCustomProgress(int, long, long, Type)}
      * method with the index of the stage.
      *
      * @param stage the javaFX stage to show the progress on; mustn't be null
      * @param done specifies the actual "done" value of the max value
      * @param max specifies the max, 100% value of the loading
      * @param type the type of the progress; mustn't be null
      * @throws NullPointerException if the stage or the type is null
-     * @see TaskbarProgressbar#showCustomProgress(int, long, long, TaskbarProgressbarType)
+     * @see TaskbarProgressbar#showCustomProgress(int, long, long, Type)
      */
-    public static void showCustomProgress(Stage stage, long done, long max, TaskbarProgressbarType type) {
+    public static void showCustomProgress(Stage stage, long done, long max, Type type) {
         showCustomProgress(getIndexOfStage(stage), done, max, type);
     }
 
@@ -141,7 +141,7 @@ public static void stopProgress(int windowIndex) {
         long hwndVal = getHWNDValueOf(windowIndex);
         progressbar.setHwnd(Pointer.pointerToAddress(hwndVal));
 
-        progressbar.getService().execute(() -> progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), TaskbarProgressbarType.NO_PROGRESS.getBridjPair()));
+        progressbar.getService().execute(() -> progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), Type.NO_PROGRESS.getBridjPair()));
     }
 
     @SuppressWarnings({"unchecked", "deprecation"})
@@ -151,11 +151,11 @@ public static void showIndeterminateProgress(int windowIndex) {
         long hwndVal = getHWNDValueOf(windowIndex);
         progressbar.setHwnd(Pointer.pointerToAddress(hwndVal));
 
-        progressbar.getService().execute(() -> progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), TaskbarProgressbarType.INDETERMINATE.getBridjPair()));
+        progressbar.getService().execute(() -> progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), Type.INDETERMINATE.getBridjPair()));
     }
 
     @SuppressWarnings({"unchecked", "deprecation"})
-    public static void showCustomProgress(int windowIndex, long done, long endValue, TaskbarProgressbarType type) {
+    public static void showCustomProgress(int windowIndex, long done, long endValue, Type type) {
         TaskbarProgressbarImpl progressbar = new TaskbarProgressbarImpl();
 
         long hwndVal = getHWNDValueOf(windowIndex);
@@ -176,7 +176,7 @@ public static void showFullErrorProgress(int windowIndex) {
 
         progressbar.getService().execute(() -> {
             progressbar.getList().SetProgressValue((Pointer) progressbar.getHwnd(), 100, 100);
-            progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), TaskbarProgressbarType.ERROR.getBridjPair());
+            progressbar.getList().SetProgressState((Pointer) progressbar.getHwnd(), Type.ERROR.getBridjPair());
         });
     }
 

images/indeterminate.gif

@@ -67,7 +67,7 @@ public void stopProgress() {
         long hwndVal = com.sun.glass.ui.Window.getWindows().get(getIndexOfStage(stage)).getNativeWindow();
         hwnd = Pointer.pointerToAddress(hwndVal);
 
-        es.execute(() -> list.SetProgressState((Pointer) hwnd, TaskbarProgressbar.TaskbarProgressbarType.NO_PROGRESS.getBridjPair()));
+        es.execute(() -> list.SetProgressState((Pointer) hwnd, Type.NO_PROGRESS.getBridjPair()));
     }
 
     @Override
@@ -76,12 +76,12 @@ public void showIndeterminateProgress() {
         long hwndVal = com.sun.glass.ui.Window.getWindows().get(getIndexOfStage(stage)).getNativeWindow();
         hwnd = Pointer.pointerToAddress(hwndVal);
 
-        es.execute(() -> list.SetProgressState((Pointer) hwnd, TaskbarProgressbar.TaskbarProgressbarType.INDETERMINATE.getBridjPair()));
+        es.execute(() -> list.SetProgressState((Pointer) hwnd, Type.INDETERMINATE.getBridjPair()));
     }
 
     @Override
     @SuppressWarnings({"unchecked", "deprecation"})
-    public void showCustomProgress(long startValue, long endValue, TaskbarProgressbar.TaskbarProgressbarType type) {
+    public void showCustomProgress(long startValue, long endValue, Type type) {
         long hwndVal = com.sun.glass.ui.Window.getWindows().get(getIndexOfStage(stage)).getNativeWindow();
         hwnd = Pointer.pointerToAddress(hwndVal);