From b1e87a899c74cfef51bda3235f13562da0cf5474 Mon Sep 17 00:00:00 2001 From: finalchild Date: Sun, 25 Aug 2024 21:14:59 +0900 Subject: [PATCH] docs: README --- README.md | 44 ++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 40 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 12bc6c4..dd767f2 100644 --- a/README.md +++ b/README.md @@ -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 + + + io.portone + server-sdk + x.y.z + + +``` + +### 앰퍼 +```YAML +dependencies: + - io.portone:server-sdk:x.y.z +``` + + ## 버전 [유의적 버전 2.0.0](https://semver.org/spec/v2.0.0.html)을 사용합니다. @@ -13,10 +53,6 @@ JVM 서버 환경에서 포트원 V2 결제 시스템에 연동하기 위한 SDK SDK의 버전을 업데이트한 경우 코드 호환성이 깨질 수 있습니다. 이 경우 코드 작업이 필요합니다. -## 의존성 -현대적인 코틀린 환경을 사용합니다. 내부 HTTP 클라이언트로는 OkHttp 엔진의 Ktor를 사용합니다. JSON 직렬화를 위해 kotlinx.serialization을 사용합니다. - - ## 개발 로드맵 * [x] 웹훅 검증을 위한 `WebhookVerifier` 제공 * [ ] REST API 연동