Skip to content

Commit 968dbd2

Browse files
committed
Add a short type summary and badges to readme
1 parent 4cb5717 commit 968dbd2

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,21 @@
11
# kotlinx-datetime
2-
Multiplatform Date/Time library for Kotlin
2+
3+
[![JetBrains incubator project](https://jb.gg/badges/incubator.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)
4+
[![GitHub license](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
5+
<!-- [ ![Download](https://api.bintray.com/packages/kotlin/kotlinx/kotlinx.datetime/images/download.svg) ](https://bintray.com/kotlin/kotlinx/kotlinx.datetime/_latestVersion) -->
6+
7+
8+
A multiplatform Kotlin library for working with date and time.
9+
10+
## Types and operations
11+
12+
The library provides the basic set of types for working with date and time:
13+
14+
- `Instant` to represent a moment on the UTC-SLS time scale;
15+
- `LocalDateTime` to represent the date and time components without a reference to the particular time zone;
16+
- `LocalDate` to represent the components of date only;
17+
- `TimeZone` and `ZoneOffset` provide time zone information to convert between `Instant` and `LocalDateTime`;
18+
- `Month` and `DayOfWeek` enums;
19+
- `CalendarPeriod` to represent a difference between two instants decomposed into calendar units. The latter are
20+
listed in `CalendarUnit` enum.
21+

0 commit comments

Comments
 (0)