Skip to content

Commit 04eb327

Browse files
author
infeo
committed
Updating README.md
1 parent 3a89a8f commit 04eb327

File tree

1 file changed

+19
-7
lines changed

1 file changed

+19
-7
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,9 @@
11
Dokan-Java
22
======
33
## Introduction
4-
Dokan-Java is a Java wrapper for [Dokany 1.x releases](https://github.com/dokan-dev/dokany/releases) and above. Using this project you are able to implement your own filesystem in Java!
4+
Dokan-Java is a Java wrapper for [Dokany 1.x releases](https://github.com/dokan-dev/dokany/releases) and above. Using this project you are able to implement your own filesystem on Windows... in Java!
55

6-
[Dokany](https://github.com/dokan-dev/dokany) is a device driver providing an interface to develop and run your own filesystem on Windows (similar to [FUSE](https://github.com/libfuse/libfuse)). But using the library directly you need to write your filesystem code in C... but fortunately there is an escape from the pointer hell: dokan-java.
7-
8-
## Important Notice
9-
This project has switched to a new architecture. The _old_ version of dokan-java can be found under [the deprecated branch](../../tree/deprecated) and will be deleted in June 2019.
6+
[Dokany](https://github.com/dokan-dev/dokany) is a device driver providing an interface to develop and run your own filesystem on Windows (similar to [FUSE](https://github.com/libfuse/libfuse)). Its native bindings are written in C/C++, this library provides via JNA a Java interface to its API with additional convenience methods.
107

118
## Runtime Dependencies
129
- [Java JRE 11](https://jdk.java.net/11/)
@@ -15,7 +12,6 @@ All dependencies can be seen in the dependecies section of [the build file](buil
1512

1613
- [JNA](https://github.com/java-native-access/jna) - provides access to [native Dokany functions](https://dokan-dev.github.io/dokany-doc/html/struct_d_o_k_a_n___o_p_e_r_a_t_i_o_n_s.html)
1714
- [Commons IO](https://commons.apache.org/proper/commons-io/)
18-
- [SLF4J](https://www.slf4j.org/)
1915
- [Guava](https://github.com/google/guava)
2016
- [JUnit 5](https://junit.org/junit5/)
2117

@@ -27,7 +23,23 @@ There are 2 ways to directly use dokan-java:
2723
### Pre-Built Version
2824
The first stable release can be found here: https://bintray.com/infeo/maven/dokan-java
2925

30-
A publication to [JCenter](https://bintray.com/bintray/jcenter) and [MavenCentral](https://repo.maven.apache.org/maven2/) is in progress.
26+
To use dokan-java in maven or gradle projects, you have to add jcenter as a repository and then find it under the following coordinates:
27+
* Maven
28+
```xml
29+
<dependency>
30+
<groupId>dev.dokan</groupId>
31+
<artifactId>dokan_java</artifactId>
32+
<version>1.1.0</version>
33+
</dependency>
34+
```
35+
* Gradle
36+
```groovy
37+
dependencies {
38+
implementation (group:'dev.dokan', name:'dokan_java', version:'1.1.0')
39+
}
40+
```
41+
42+
A publication to [MavenCentral](https://repo.maven.apache.org/maven2/) is in progress.
3143

3244
### Build Instructions
3345
Prerequisite: [JDK 11](https://jdk.java.net/11/)

0 commit comments

Comments
 (0)