diff --git a/README.md b/README.md index df69ec2..540f946 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ [![Build Status](https://github.com/cryptomator/dokany-nio-adapter/workflows/Build/badge.svg)](https://github.com/cryptomator/dokany-nio-adapter/actions?query=workflow%3ABuild) -[![Codacy Code Quality](https://app.codacy.com/project/badge/Grade/f3f46474adb14bc59d4fc489903950f5)](https://www.codacy.com/gh/cryptomator/dokany-nio-adapter/dashboard) -[![Codacy Coverage](https://app.codacy.com/project/badge/Coverage/f3f46474adb14bc59d4fc489903950f5)](https://www.codacy.com/gh/cryptomator/dokany-nio-adapter/dashboard) [![Known Vulnerabilities](https://snyk.io/test/github/cryptomator/dokany-nio-adapter/badge.svg)](https://snyk.io/test/github/cryptomator/dokany-nio-adapter) # dokany-nio-adapter -Provides directory contents specified by a `java.nio.file.Path` via a Dokany filesystem. +Provides directory content specified by a `java.nio.file.Path` via a [Dokany](https://dokan-dev.github.io/) filesystem. + +Important notice: *Only Dokany 1.5.x is supported*. Hence, older minor (1.4.x, 1.3.x, etc.) or newer major versions (like 2.x.x) are not supported. ## Configuration parameters @@ -14,7 +14,7 @@ This library uses the following system properties: ## Usage -Have a look at `org.cryptomator.frontend.dokany.ReadWriteMirrorTest` in the test package. +Have a lookt at the [examples](/src/test/java/org/cryptomator/frontend/dokany/ExampleFilesystemTests.java). ## License This project is dual-licensed under the AGPLv3 for FOSS projects as well as a commercial license for independent software vendors and resellers. If you want to use this library in applications, that are *not* licensed under the AGPL, feel free to contact our [support team](https://cryptomator.org/help/).