Skip to content

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
adrielcafe committed Mar 26, 2022
1 parent 96a385c commit dddd9ad
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 5 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,21 @@
[![License MIT](https://img.shields.io/github/license/adrielcafe/lyricist.svg?style=for-the-badge&color=orange)](https://opensource.org/licenses/MIT)

# Lyricist 🌎🌍🌏
> The missing [I18N and L10N](https://en.wikipedia.org/wiki/Internationalization_and_localization) library for [Jetpack Compose](https://developer.android.com/jetpack/compose)!
> The missing [I18N and L10N](https://en.wikipedia.org/wiki/Internationalization_and_localization) multiplatform library for [Jetpack Compose](https://developer.android.com/jetpack/compose)!
Jetpack Compose greatly improved the way we build UIs on Android, but not how we **interact with strings**. `stringResource()` works well, but doesn't benefit from the idiomatic Kotlin like Compose.

Lyricist tries to make working with strings as powerful as building UIs with Compose, *i.e.*, working with parameterized string is now typesafe, use of `when` expression to work with plurals with more flexibility, and even load/update the strings dynamically via an API!

#### Features
- [x] Multiplatform: Android, Desktop
- [x] [Simple API](#usage) to handle locale changes and provide the current strings
- [x] [Multi module support](#multi-module-settings)
- [x] Code generation with [KSP](https://github.com/google/ksp)
- [x] [Easy migration](#migrating-from-stringsxml) from `strings.xml`
- [x] Code generation with [KSP](https://github.com/google/ksp)

#### Roadmap
- [Compose for Desktop](https://github.com/JetBrains/compose-jb) support
- iOS support

#### Limitations
* The XML processor doesn't handle `few` and `many` [plural values](https://developer.android.com/guide/topics/resources/string-resource#Plurals) (PRs are welcome)
Expand Down
4 changes: 2 additions & 2 deletions buildSrc/src/main/kotlin/Setup.kt
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ private fun BaseExtension.android() {
}

fun Project.kotlinMultiplatform(
withKotlinExplicitMode: Boolean = true
explicitMode: Boolean = true
) {
extensions.configure<KotlinMultiplatformExtension> {
android {
Expand Down Expand Up @@ -65,7 +65,7 @@ fun Project.kotlinMultiplatform(
}

tasks.withType<KotlinCompile> {
kotlinOptions.setup(withKotlinExplicitMode)
kotlinOptions.setup(explicitMode)
}

}
Expand Down

0 comments on commit dddd9ad

Please sign in to comment.