Update docs

kizitonwose · Jul 18, 2024 · 185f433 · 185f433
1 parent f32997b
commit 185f433
Show file tree

Hide file tree

Showing 2 changed files with 69 additions and 34 deletions.
diff --git a/README.md b/README.md
@@ -1,10 +1,11 @@
 # Calendar
 
-A highly customizable calendar library for Android, backed by RecyclerView for the view system, and LazyRow/LazyColumn for compose.
+A highly customizable calendar library for Android and Compose Multiplatform, backed by RecyclerView for the view system, and LazyRow/LazyColumn for compose.
 
 [![Tests](https://github.com/kizitonwose/Calendar/workflows/Check/badge.svg?branch=main)](https://github.com/kizitonwose/Calendar/actions)
-[![Maven Central](https://img.shields.io/badge/dynamic/xml.svg?label=Maven%20Central&color=blue&url=https://repo1.maven.org/maven2/com/kizitonwose/calendar/core/maven-metadata.xml&query=(//metadata/versioning/versions/version)[not(contains(text(),%27-%27))][last()])](https://central.sonatype.com/search?q=g:com.kizitonwose.calendar)
-[![Maven Central Beta](https://img.shields.io/badge/dynamic/xml.svg?label=Maven%20Central%20Beta&color=slateblue&url=https://repo1.maven.org/maven2/com/kizitonwose/calendar/core/maven-metadata.xml&query=(//metadata/versioning/versions/version)[contains(text(),%27beta%27)][last()])](https://central.sonatype.com/search?q=g:com.kizitonwose.calendar)
+[![Android Library](https://img.shields.io/badge/dynamic/xml.svg?label=Android%20Library&color=blue&url=https://repo1.maven.org/maven2/com/kizitonwose/calendar/core/maven-metadata.xml&query=(//metadata/versioning/versions/version)[not(contains(text(),%27-%27))][last()])](https://central.sonatype.com/search?q=g:com.kizitonwose.calendar)
+[![Android Library Beta](https://img.shields.io/badge/dynamic/xml.svg?label=Android%20Library%20Beta&color=slateblue&url=https://repo1.maven.org/maven2/com/kizitonwose/calendar/core/maven-metadata.xml&query=(//metadata/versioning/versions/version)[contains(text(),%27beta%27)][last()])](https://central.sonatype.com/search?q=g:com.kizitonwose.calendar)
+[![Multiplatform Library Alpha](https://img.shields.io/badge/dynamic/xml.svg?label=Multiplatform%20Library%20Alpha&color=slateblue&url=https://repo1.maven.org/maven2/com/kizitonwose/calendar/compose-multiplatform/maven-metadata.xml&query=(//metadata/versioning/versions/version)[contains(text(),%27alpha%27)][last()])](https://central.sonatype.com/search?q=g:com.kizitonwose.calendar)
 [![License](https://img.shields.io/badge/License-MIT-0097A7.svg)](https://github.com/kizitonwose/Calendar/blob/main/LICENSE.md)
 [![Twitter](https://img.shields.io/badge/[email protected])](https://twitter.com/kizitonwose)
 
@@ -39,17 +40,25 @@ A highly customizable calendar library for Android, backed by RecyclerView for t
 It's important to check out the sample app. There are lots of examples provided for both view and compose implementations. 
 Most techniques that you would want to implement are already done in the examples.
 
-Download the sample app [here](https://github.com/kizitonwose/Calendar/releases/download/2.0.0/sample.apk)
+Download the Android sample app [here](https://github.com/kizitonwose/Calendar/releases/download/2.0.0/sample.apk)
 
-View the sample app's source code [here](https://github.com/kizitonwose/Calendar/tree/main/sample)
+View the Android sample app's source code [here](https://github.com/kizitonwose/Calendar/tree/main/sample)
+
+View the multiplatform sample project online at https://calendar.kizitonwose.dev
+
+View the multiplatform sample project's source code [here](https://github.com/kizitonwose/Calendar/tree/main/compose-multiplatform/sample)
 
 ## Setup
 
+The library provides two compose artifacts: `com.kizitonwose.calendar:compose` which uses the [java.time](https://docs.oracle.com/javase/8/docs/api/java/time/package-summary.html) APIs for pure Android projects and `com.kizitonwose.calendar:compose-multiplatform` which uses the [kotlinx-datetime](https://github.com/Kotlin/kotlinx-datetime) library for Compose Multiplatform projects. 
+
+The Android view library artifact `com.kizitonwose.calendar:view` also uses the `java.time` APIs and can exist alongside the Android compose artifact in an Android project if needed.
+
 #### Step 1
 
-**This step is required ONLY if your app's `minSdkVersion` is below 26. Jump to [step 2](#step-2) if this does not apply to you.**
+**This step is required ONLY if your Android app's `minSdkVersion` is below 26. Jump to [step 2](#step-2) if this does not apply to you.**
 
-Apps with `minSdkVersion` below 26 have to enable [Java 8+ API desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) for backward compatibility since `java.time` classes were added in Java 8 which is supported natively starting from Android SDK 26. To set up your project for desugaring, you need to first ensure that you are using [Android Gradle plugin](https://developer.android.com/studio/releases/gradle-plugin#updating-plugin) 4.0.0 or higher.
+Android apps with `minSdkVersion` below 26 have to enable [Java 8+ API desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring) for backward compatibility since `java.time` classes were added in Java 8 which is supported natively starting from Android SDK 26. To set up your project for desugaring, you need to first ensure that you are using [Android Gradle plugin](https://developer.android.com/studio/releases/gradle-plugin#updating-plugin) 4.0.0 or higher.
 
 Then include the following in your app's `build.gradle` file:
 
@@ -81,36 +90,46 @@ dependencies {
 
 You can find the latest version of `desugar_jdk_libs` [here](https://mvnrepository.com/artifact/com.android.tools/desugar_jdk_libs).
 
-#### Step 2
+#### Step 2A - For pure Android projects without multiplatform setup
 
-Add the desired calendar library (view or compose) to your app `build.gradle`:
+Add the desired calendar library (view or compose) to your app's `build.gradle.kts`:
 
-```groovy
+```kotlin
 dependencies {
-  // The view calendar library
-  implementation 'com.kizitonwose.calendar:view:<latest-version>'
+  // The view calendar library for Android
+  implementation("com.kizitonwose.calendar:view:<latest-version>")
+
+  // The compose calendar library for Android
+  implementation("com.kizitonwose.calendar:compose:<latest-version>")
+}
+```
+
+#### Step 2B - For Compose Multiplatform projects
 
-  // The compose calendar library
-  implementation 'com.kizitonwose.calendar:compose:<latest-version>'
+Add the multiplatform calendar library to your project's `build.gradle.kts`:
+
+```kotlin
+commonMain.dependencies {
+  implementation("com.kizitonwose.calendar:compose-multiplatform:<latest-version>")
 }
 ```
 
 You can find the latest version of the library on the maven central badge above.
 
 Snapshots of the development version are available in [Sonatype’s snapshots repository](https://s01.oss.sonatype.org/content/repositories/snapshots/com/kizitonwose/calendar/).
 
-If you're upgrading from version 1.x.x to 2.x.x, see the [migration guide](https://github.com/kizitonwose/calendar/blob/main/docs/MigrationGuide.md).
+#### Compose UI version compatibility
 
 For the compose calendar library, ensure that you are using the library version that matches the Compose UI version in your project. If you use a version of the library that has a higher version of Compose UI than the one in your project, gradle will upgrade the Compose UI version in your project via transitive dependency.
 
-| Compose UI | Calendar Library |
-|:----------:|:----------------:|
-|   1.2.x    |      2.0.x       |
-|   1.3.x    |  2.1.x - 2.2.x   |
-|   1.4.x    |      2.3.x       |
-|   1.5.x    |      2.4.x       |
-|   1.6.x    |      2.5.x       |
-|   1.7.x    |      2.6.x       |
+| Compose UI | Android Calendar Library | Multiplatform Calendar Library |
+|:----------:|:------------------------:|:------------------------------:|
+|   1.2.x    |           2.0.x          |                 -              |
+|   1.3.x    |       2.1.x - 2.2.x      |                 -              |
+|   1.4.x    |           2.3.x          |                 -              |
+|   1.5.x    |           2.4.x          |                 -              |
+|   1.6.x    |           2.5.x          |                 -              |
+|   1.7.x    |           2.6.x          |               2.6.x            |
 
 ## Usage
 
@@ -119,6 +138,10 @@ You can find the relevant documentation for the library in the links below.
 |[View-based documentation](https://github.com/kizitonwose/Calendar/blob/main/docs/View.md)|[Compose documentation](https://github.com/kizitonwose/Calendar/blob/main/docs/Compose.md)|
 |:-:|:-:|
 
+## Migration
+
+If you're upgrading from calendar library version 1.x.x to 2.x.x, see the [migration guide](https://github.com/kizitonwose/calendar/blob/main/docs/MigrationGuide.md).
+
 ## Share your creations
 
 Made a cool calendar with this library? Share an image [here](https://github.com/kizitonwose/Calendar/issues/1).

diff --git a/docs/Compose.md b/docs/Compose.md
@@ -3,6 +3,7 @@
 ## Table of Contents
 
 - [Quick links](#quick-links)
+- [Compose Multiplatform Information](#compose-multipletform-information)
 - [Compose versions](#compose-versions)
 - [Calendar Composables](#calendar-composables)
 - [Usage](#usage)
@@ -23,25 +24,36 @@
 
 Check out the sample app if you have not yet done so. Most techniques that you would want to implement are already done in the examples.
 
-Download the sample app [here](https://github.com/kizitonwose/Calendar/releases/download/2.0.0/sample.apk)
+Download the Android sample app [here](https://github.com/kizitonwose/Calendar/releases/download/2.0.0/sample.apk)
 
-Read the sample app's source code [here](https://github.com/kizitonwose/Calendar/tree/main/sample)
+Read the Android sample app's source code [here](https://github.com/kizitonwose/Calendar/tree/main/sample)
+
+View the multiplatform sample project online at https://calendar.kizitonwose.dev
+
+Read the multiplatform sample project's source code [here](https://github.com/kizitonwose/Calendar/tree/main/compose-multiplatform/sample)
 
 Add the library to your project [here](https://github.com/kizitonwose/Calendar#setup)
 
 **If you are looking for the view-based documentation, you can find it [here](https://github.com/kizitonwose/Calendar/blob/main/docs/View.md)**
 
-## Compose versions
+## Compose Multiplatform Information
+
+The APIs for the compose libraries for Android and Multiplatform projects have been designed such that you can copy examples across both projects and they would work without code changes as the classes have the same names and package declarations. The only difference in some cases would be that the code for the Android calendar library needs to import classes such as `LocalDate` and `YearMonth` from the `java.time` package while the multiplaform calendar library needs to import such classes from the [kotlinx-datetime](https://github.com/Kotlin/kotlinx-datetime) library. 
+
+Note that the `YearMonth` class does not yet exist in the `kotlinx-datetime` library, therefore the multiplatfrom calendar library includes a minimal `YearMonth` class implementation to bridge this gap until the class [is hopefully added](https://github.com/Kotlin/kotlinx-datetime/issues/168) to the `kotlinx-datetime` library.
+
+The functions `plusMonths`, `minusMonths`, `plusDays` and `minusDays` used in the examples are provided out of the box by the `java.time` library, but can be easily added for multiplatform projects using the `kotlinx-datetime` library if needed:
+
+```kotlin
+fun YearMonth.plusMonths(value: Int): YearMonth = plus(value, DateTimeUnit.MONTH)
+fun YearMonth.minusMonths(value: Int): YearMonth = minus(value, DateTimeUnit.MONTH)
+fun LocalDate.plusDays(value: Int): LocalDate = plus(value, DateTimeUnit.DAY)
+fun LocalDate.minusDays(value: Int): LocalDate = minus(value, DateTimeUnit.DAY)
+```
 
-Ensure that you are using the library version that matches with the Compose UI version in your project. If you use a version of the library that has a higher version of Compose UI than the one in your project, gradle will upgrade the Compose UI version in your project via transitive dependency.
+## Compose UI versions
 
-| Compose UI | Calendar Library |
-|:----------:|:----------------:|
-|   1.2.x    |      2.0.x       |
-|   1.3.x    |  2.1.x - 2.2.x   |
-|   1.4.x    |      2.3.x       |
-|   1.5.x    |      2.4.x       |
-|   1.6.x    |      2.5.x       |
+Ensure that you are using the library version that matches the Compose UI version in your project. If you use a version of the library that has a higher version of Compose UI than the one in your project, gradle will upgrade the Compose UI version in your project via transitive dependency. See the compatibility table [here](https://github.com/kizitonwose/Calendar#compose-ui-version-compatibility).
 
 ## Calendar Composables