Skip to content

Commit 6d2f9f1

Browse files
author
krystian.panek
committed
Docs update
1 parent ef94d84 commit 6d2f9f1

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

+7-2
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,19 @@
88

99
## Description
1010

11-
It is a reusable wrapper for file exclusion mechanism extracted from [NetBeans Git Module](https://github.com/myabc/nbgit/tree/master/src/org/nbgit/util/exclude).
11+
It is a reusable Java wrapper for [GitIgnore](https://git-scm.com/docs/gitignore) file exclusion mechanism extracted from [NetBeans Git Module](https://github.com/myabc/nbgit/tree/master/src/org/nbgit/util/exclude).
1212

13+
Useful for Java applications or libraries which wants to use GitIgnore like file filtering.
14+
15+
Supports nested *.gitignore* files.
1316

1417
## Usage
1518

19+
Sample Kotlin code:
20+
1621
```kotlin
1722
val rootDir = File("/some/root")
18-
val sampleFile = File("SomeClass.class", rootDir)
23+
val sampleFile = File("class/SomeClass.class", rootDir)
1924
val gitIgnore = GitIgnore(rootDir)
2025

2126
if (gitIgnore.isExcluded(sampleFile)) {

0 commit comments

Comments
 (0)