Skip to content

Commit

Permalink
🎉 Release v1.0.6
Browse files Browse the repository at this point in the history
  • Loading branch information
sya-ri committed Nov 16, 2023
1 parent c401af0 commit 6db76e3
Showing 1 changed file with 30 additions and 24 deletions.
54 changes: 30 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -17,7 +45,7 @@ repositories {
}
dependencies {
implementation 'com.github.sya-ri:kgit:1.0.5'
implementation 'com.github.sya-ri:kgit:1.0.6'
}
```

Expand All @@ -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")
}
```

Expand Down

0 comments on commit 6db76e3

Please sign in to comment.