Skip to content

Commit 79bad8e

Browse files
committed
Update README
1 parent 355da68 commit 79bad8e

1 file changed

Lines changed: 27 additions & 35 deletions

File tree

README.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,19 @@
11
# ![JavaFXTaskbarProgressbar](images/Logo.png)
22
<p align="center"><b>A clean and easy way to implement this amazing native Windows taskbar-progressbar functionality in javaFX</b></p>
33

4-
###### This library allows you to add native taskbar-progressbar functionality to your JavaFX Stages.
5-
6-
For the native access this project uses [bridj](https://github.com/nativelibs4java/BridJ)
4+
## Background
5+
Since Windows 7 there is a taskbar-progressbar feature in Windows systems
6+
that basically means that you can see progress on the program's taskbar icon.
7+
A good example for this when you copy something using the file explorer:<br>
8+
![Taskbar progressbar in windows 7](images/areo-progressbar.jpg) <br>
9+
This is very useful because you don't have to open the window to see the progress!
10+
The problem is that javaFX doesn't provide this functionality by default... however you
11+
can easily implement it with this library!
12+
It enables you to do this in pure java!
713

814
## Compatibility
915
This library has support for java 8 and java 11 too.<br>
16+
<b>The 'v11.x' versions are for java11 users and the 'v8.x' versions are for java 8 users.</b>
1017

1118
##### Using with java 11
1219
If you use java 11 you have to pass this VM argument: `--add-exports javafx.graphics/com.sun.glass.ui=nativejavafx.taskbar`.
@@ -16,36 +23,11 @@ module YourModule {
1623
...
1724
requires nativejavafx.taskbar;
1825
}
19-
```
20-
21-
## Source code
22-
This project has two important branches:
23-
* "master" - for java 8 builds
24-
* "11" - for java 11 builds
25-
26-
## Background
27-
Since Windows 7 there is a taskbar-progressbar feature in Windows systems
28-
that basically means that you can see a progress on the program's icon.
29-
A good example for this when you copy something using the file explorer:<br>
30-
![Taskbar progressbar in windows 7](images/areo-progressbar.jpg) <br>
31-
This is very useful because you don't have to open the window to see the progress!
32-
The problem is that javaFX doesn't provide this functionality by default... however you
33-
can easily implement it with this library!
34-
It enables you to do this in pure java!
26+
```
3527

3628
## How to include it to your project
3729

38-
### 1. Manually
39-
You can download the right jar file from the [releases](https://github.com/Dansoftowner/FXTaskbarProgressBar/releases).
40-
<br>
41-
Every release has two jar files: one is a fat jar (it's name ends with '*-full-x.x.jar') that contains the bridj binaries
42-
as well <i>(so if you use this you don't have to include bridj separately for your project)</i>;
43-
and another jar that doesn't contain the external bridj binaries <i>(in this case you have
44-
to download the bridj binaries separately)</i>.
45-
<br><b>The 'v11.x' versions are for java11 users and the 'v8.x' versions are for java 8 users.</b>
46-
47-
### 2. Using with Maven, Gradle etc...
48-
<b>Maven example:</b><br>
30+
### Maven example:
4931

5032
Add JitPack.io to your repositories :
5133
```xml
@@ -61,11 +43,11 @@ Add the dependency:
6143
<dependency>
6244
<groupId>com.github.Dansoftowner</groupId>
6345
<artifactId>FXTaskbarProgressBar</artifactId>
64-
<version>v11.2.7</version>
46+
<version>v11.3</version>
6547
</dependency>
6648
```
6749

68-
<b>Gradle example</b>
50+
### Gradle example
6951

7052
Add the repository:
7153
```groovy
@@ -79,7 +61,7 @@ Add the dependency:
7961
```groovy
8062
dependencies {
8163
//...
82-
implementation 'com.github.Dansoftowner:FXTaskbarProgressBar:v11.2.7'
64+
implementation 'com.github.Dansoftowner:FXTaskbarProgressBar:v11.3'
8365
}
8466
```
8567

@@ -93,7 +75,7 @@ Before we jump in, we have to know the 4 types of a taskbar-progressbar:<br>
9375
* `INDETERMINATE` - a progressbar that doesn't show any fix progress
9476
* `NO_PROGRESS` - a progressbar that doesn't show anything
9577
<br><br>
96-
All these types are represented by an enum called `com.nativejavafx.taskbar.TaskbarProgressbar.Type`.
78+
All these types are represented by the enum called `com.nativejavafx.taskbar.TaskbarProgressbar.Type`.
9779

9880
Now let's see how can we actually use this through code.<br>
9981
There are multiple ways to create taskbar progressbars with this library:
@@ -196,12 +178,22 @@ Some more screenshots about what can you do with this library
196178
Code: `progressbar.showCustomProgress(70, 100, TaskbarProgressbar.Type.PAUSED);`<br>
197179
![Paused progress](images/paused-progress.jpg)
198180
* An error progress example:<br>
199-
Code: `progressbar.showCustomProgress(40, 100, TaskbarProgressbar.Type.ERROR);`<br>
181+
Code: `progressbar.showCustomProgress(40, 100, TaskbarProgressbar.Type.ERROR);`<br>b
200182
![Paused progress](images/error-progress.jpg)
201183

202184
## Full demo
203185
A full demo-example class is available [here](src/test/java/Demo.java).
204186

187+
## Source code
188+
This project has two important branches:
189+
* "master" - for java 8 builds
190+
* "11" - for java 11 builds
191+
192+
## Used libraries
193+
* [bridj](https://github.com/nativelibs4java/BridJ) - blazing fast Java / C / C++ interop
194+
* [SLF4J](http://www.slf4j.org/) - Simple Logging Facade for Java
195+
* [Jetbrains Annotations](https://github.com/JetBrains/java-annotations) - Annotations for JVM-based languages
196+
205197
## Support
206198
If you like this library please give me a star! It's very important for me
207199
because it keeps me motivated to work on this library. Thank you!

0 commit comments

Comments
 (0)