diff --git a/README.md b/README.md index 9eb75d1..364b3fa 100644 --- a/README.md +++ b/README.md @@ -6,9 +6,37 @@ KGit is Kotlin Wrapper Library of [JGit](https://eclipse.org/jgit). - Null Safety Methods - Command Settings Available Using Lambda Function (No Method Chain) +- Support JGit features: `6.7.0.202309050840-r` + +## Examples + +### Clone Repository + +#### JGit +```kotlin +val git: Git = Git.cloneRepository() + .setURI("https://github.com/sya-ri/KGit") + .setTimeout(60) + .setProgressMonitor(TextProgressMonitor()) + .call() +``` + +#### KGit +```kotlin +val git: KGit = KGit.cloneRepository { + setURI("https://github.com/sya-ri/KGit") + setTimeout(60) + setProgressMonitor(TextProgressMonitor()) +} +``` ## Installation +> [!TIP] +> +> - KGit bundles `org.eclipse.jgit:org.eclipse.jgit`. +> - Install the jgit extension library if necessary. + ### build.gradle ```groovy @@ -17,7 +45,7 @@ repositories { } dependencies { - implementation 'com.github.sya-ri:kgit:1.0.5' + implementation 'com.github.sya-ri:kgit:1.0.6' } ``` @@ -29,29 +57,7 @@ repositories { } dependencies { - implementation("com.github.sya-ri:kgit:1.0.5") -} -``` - -## Examples - -### Clone Repository - -#### JGit -```kotlin -val git: Git = Git.cloneRepository() - .setURI("https://github.com/sya-ri/KGit") - .setTimeout(60) - .setProgressMonitor(TextProgressMonitor()) - .call() -``` - -#### KGit -```kotlin -val git: KGit = KGit.cloneRepository { - setURI("https://github.com/sya-ri/KGit") - setTimeout(60) - setProgressMonitor(TextProgressMonitor()) + implementation("com.github.sya-ri:kgit:1.0.6") } ```