Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
finalchild committed Aug 25, 2024
1 parent 20f8992 commit b1e87a8
Showing 1 changed file with 40 additions and 4 deletions.
44 changes: 40 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,46 @@
JVM 서버 환경에서 포트원 V2 결제 시스템에 연동하기 위한 SDK입니다. 코틀린, 스칼라, 자바 등의 언어에서 사용할 수 있습니다.


## 의존성
JVM 11 이상이 필요합니다.

현대적인 코틀린 환경을 사용해 구현합니다. 내부 HTTP 클라이언트로는 OkHttp 엔진의 Ktor를 사용합니다. JSON 직렬화를 위해 kotlinx.serialization을 사용합니다.


## 설치
[![Maven Central Version](https://img.shields.io/maven-central/v/io.portone/server-sdk)](https://central.sonatype.com/artifact/io.portone/server-sdk)

메이븐 중앙 저장소를 통해 설치합니다.

### 그래들
```Gradle Kotlin DSL
dependencies {
implementation("io.portone:server-sdk:x.y.z")
}
repositories {
mavenCentral()
}
```

### 메이븐
```XML
<dependencies>
<dependency>
<groupId>io.portone</groupId>
<artifactId>server-sdk</artifactId>
<version>x.y.z</version>
</dependency>
</dependencies>
```

### 앰퍼
```YAML
dependencies:
- io.portone:server-sdk:x.y.z
```
## 버전
[유의적 버전 2.0.0](https://semver.org/spec/v2.0.0.html)을 사용합니다.
Expand All @@ -13,10 +53,6 @@ JVM 서버 환경에서 포트원 V2 결제 시스템에 연동하기 위한 SDK
SDK의 버전을 업데이트한 경우 코드 호환성이 깨질 수 있습니다. 이 경우 코드 작업이 필요합니다.
## 의존성
현대적인 코틀린 환경을 사용합니다. 내부 HTTP 클라이언트로는 OkHttp 엔진의 Ktor를 사용합니다. JSON 직렬화를 위해 kotlinx.serialization을 사용합니다.


## 개발 로드맵
* [x] 웹훅 검증을 위한 `WebhookVerifier` 제공
* [ ] REST API 연동
Expand Down

0 comments on commit b1e87a8

Please sign in to comment.