Skip to content

Commit 50b88fa

Browse files
committed
docs: 라이브러리 주요 특징 설명 작성
1 parent 4c474ad commit 50b88fa

File tree

2 files changed

+29
-11
lines changed

2 files changed

+29
-11
lines changed

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,22 +8,40 @@
88

99
# Kotlin용 java.time.* 확장 라이브러리
1010

11-
`java-time-extensions``java.time.*` 패키지의 자주 사용되는 기능을 확장하여, `kotlin` 사용자에게 유의미한 경험을 제공합니다.
11+
`java-time-extensions``java.time.*` 패키지를 확장하여 Kotlin 사용자에게 더 편리한 기능을 제공합니다.
12+
이 라이브러리는 Kotlin 개발자들이 `java.time.*` API를 사용할 때 자주 필요한 기능을 쉽게 사용할 수 있도록 도와줍니다.
1213

13-
기능 사용법은 [Wiki](https://github.com/HarryJhin/java-time-extensions/wiki)를 참조하세요.
14+
사용 예시는 [Wiki](https://github.com/HarryJhin/java-time-extensions/wiki)를 참조하세요.
15+
16+
## 주요 특징
17+
18+
`java-time-extensions`는 Kotlin 사용자들에게 `java.time.*` 패키지의 다양한 클래스(`LocalDate`, `LocalTime`, `LocalDateTime` 등)를
19+
확장하여 더욱 편리하게 사용할 수 있도록 돕는 라이브러리입니다.
20+
이 라이브러리는 확장 함수와 확장 프로퍼티를 통해 기존 API를 간편하게 확장하여 사용할 수 있는 기능을 제공합니다.
21+
22+
주요 기능들은 다음과 같습니다:
23+
24+
- **다양한 날짜 및 시간 타입 확장**: `java.time.*` 패키지의 여러 클래스에 대한 유용한 확장 기능을 제공합니다.
25+
- **편리한 인스턴스 생성**: `String`, `Int`, `Long` 등의 다양한 타입으로부터 쉽게 인스턴스를 생성할 수 있습니다.
26+
- **유연한 타입 변환**: 날짜 및 시간 인스턴스를 다른 타입으로 쉽게 변환할 수 있도록 도와줍니다.
27+
- **Safety 타입 변환**: 다양한 타입 변환 함수들은 예외를 던지지 않고 `null`을 반환할 수 있도록 지원합니다.
28+
- **직관적인 중위 함수**: `LocalDate``LocalTime`을 결합하여 `LocalDateTime`을 만들거나,
29+
`LocalDate` 인스턴스 간의 차이를 계산하는 등, 기존 메서드를 사용하는 것보다 직관적인 문법을 제공합니다.
1430

1531
## kotlinx-datetime 비교
1632

17-
`kotilnx-datetime` 라이브러리는 사람들이 시간에 대해 이야기할 때 사용하는 로컬 시간대(UTC+9 등)를
18-
전제로 하는 civil time(상용시)를 명확하게 구분합니다.
19-
즉, 라이브러리에서 제공하는 엔티티는 시간대 정보를 반드시 포함하고 있습니다.
20-
그러나, 한 달 더하기와 같은 시간대 정보가 불필요한 편의 연산은 제공합니다.
33+
`kotlinx-datetime`은 시간대를 포함한 civil time(상용시)을 다루는데 특화된 라이브러리입니다.
34+
예를 들어, kotlinx-datetime은 모든 시간 객체에 시간대 정보를 포함시키며,
35+
이를 통해 로컬 시간대(예: UTC+9)와 관련된 작업을 쉽게 처리할 수 있습니다.
36+
이 라이브러리는 시간대 정보가 필요하지 않은 단순한 연산(예: 한 달 더하기)도 지원합니다.
2137

22-
`java-time-extensions` 라이브러리는 `kotlinx-datetime` 라이브러리와 비슷한 기능을 일부 제공합니다.
23-
단, `java.time.*` 패키지를 확장하는 것이 목적이므로, 별도로 구현된 엔티티를 제공하지 않습니다.
38+
반면, `java-time-extensions``java.time.*` 패키지를 기반으로 하여,
39+
기존의 API를 더 편리하게 사용할 수 있도록 돕는 확장 기능을 제공합니다.
40+
`kotlinx-datetime`처럼 새로운 엔티티나 시간대에 대한 복잡한 처리를 추가하지는 않습니다.
41+
대신, `java.time.*` 패키지를 사용하는 **Kotlin 사용자**들이 더 쉽게 날짜와 시간을 다룰 수 있도록 하는 것이 이 라이브러리의 주된 목적입니다.
2442

25-
이 라이브러리는 `kotlinx-datetime`를 대체하려는 것이 아니라,
26-
`java.time.*` 패키지를 사용하는 `kotlin` 사용자에게 더 나은 경험을 제공하기 위한 것입니다.
43+
따라서 `java-time-extensions` `kotlinx-datetime`을 대체하기 위한 것이 아니라,
44+
이미 `java.time.*`을 사용하고 있는 Kotlin 개발자들에게 **더 나은 개발 경험을 제공**하는 데 초점을 맞추고 있습니다.
2745

2846
## Gradle 설정
2947

build.gradle.kts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ plugins {
1212

1313
project.description = "Kotlin을 위한 java.time.* 확장 함수 라이브러리"
1414
project.group = "io.github.harryjhin"
15-
project.version = "0.13.5"
15+
project.version = "0.13.6"
1616

1717
repositories {
1818
mavenCentral()

0 commit comments

Comments
 (0)