Version 2.0.0-alpha01

Author: Skeptick

README.md

@@ -1,6 +1,16 @@
 # Libres
 
-Resources generation in Kotlin Multiplatform.
+String resources generation in Kotlin Multiplatform.
+
+> [!IMPORTANT]
+> Starting from __version 2.0.0__, this plugin __no longer supports image sharing__.  
+> If you want to continue using it for strings, you’ll need to migrate your image sharing to another solution —
+> for example, [Compose Multiplatform Resources](https://www.jetbrains.com/help/kotlin-multiplatform-dev/compose-multiplatform-resources.html).
+>   
+> __Why?__  
+> I like my implementation for strings — having direct access to `String` is much more convenient than various wrappers in alternative solutions.  
+> However, I’m not happy with my implementation for images: it turned out to be unintuitive, dependent on the CocoaPods plugin on iOS, and rather unstable.  
+> I don’t have the time or motivation to maintain and improve this functionality, so I decided to remove it.
 
 ## Setup
 
@@ -9,7 +19,7 @@ Resources generation in Kotlin Multiplatform.
 
 buildscript {
     dependencies {
-        classpath("io.github.skeptick.libres:gradle-plugin:1.2.4")
+        classpath("io.github.skeptick.libres:gradle-plugin:2.0.0-alpha01")
     }
 }
 ```
@@ -29,63 +39,13 @@ libres {
 }
 ```
 
-## Jetpack Compose
-
-```kotlin
-// build.gradle.kts (module)
-
-kotlin {
-    commonMain {
-        dependencies {
-            implementation("io.github.skeptick.libres:libres-compose:1.2.4")
-        }
-    }
-}
-```
-
-This artifact provides `painterResource` function that can be used
-to get `Painter` from `io.github.skeptick.libres.Image` in common code.
-
 ## Supported platforms
 
 - **Android**, **JVM**, **iOS**, **MacOS** and **JS** in Kotlin Multiplatform projects.  
 - Pure Android or JVM projects with Kotlin.
 
-## Requirements
-
-|                       |                               |
-|-----------------------|-------------------------------|
-| Kotlin                | 1.6.20+                       |
-| Android               | 4.1+ (API level 16)           |
-| Android Gradle Plugin | 7.0+                          |
-| iOS                   | 13+ (when using vector icons) |
-
-\
-:bangbang: Also you need to use [CocoaPods](https://cocoapods.org/) and 
-[CocoaPods Gradle plugin](https://kotlinlang.org/docs/native-cocoapods-dsl-reference.html) 
-to export images to iOS application.  
-If you aren't reusing images in iOS then this condition is optional.
-
 ## Known issues
 
-### iOS
-:warning: Cocoapods caches list of resource directories when `pod install` is called,
-so bundles directory must exist at this time.
-You won't see this issue if your `.podspec` is in `.gitignore`
-in any case it's best to be safe with this hook in your Podfile.
-
-Suppose your Kotlin Framework is added like this:
-```ruby
-pod 'umbrella', :path => '../common/umbrella/umbrella.podspec'
-```
-
-Then this hook will look like this:
-```ruby
-pre_install do |installer|
-  FileUtils.mkdir_p(installer.sandbox.root.to_s + '/../../common/umbrella/build/generated/libres/apple/libres-bundles')
-end
-```
-
 ## Usage
 
 Resources must be stored in `{yourSourceSetName}/libres`
@@ -95,9 +55,6 @@ Multiplatform:
 ├── commonMain
 │   ├── kotlin
 │   └── libres
-│       ├── images
-│       │   ├── vector_image.svg
-│       │   └── raster_image.png
 │       └── strings
 │           ├── strings_en.xml
 │           └── strings_ru.xml
@@ -108,9 +65,6 @@ Android or JVM:
 ├── main
 │   ├── java
 │   └── libres
-│       ├── images
-│       │   ├── vector_image.svg
-│       │   └── raster_image.png
 │       └── strings
 │           ├── strings_en.xml
 │           └── strings_ru.xml
@@ -151,71 +105,3 @@ MainRes.shared.string.simple_string
 > This seems familiar but ability to work directly with strings instead of resource IDs can be misused.
 ***
 #### [More about localization](docs/LOCALIZATION.md)
-
-### Images
-
-Supported formats:
-- PNG
-- JPG
-- WEBP (Android 4.3+, iOS 14+)
-- SVG (iOS 13+)
-
-For Android SVGs are converted to 
-[vector drawable](https://developer.android.com/develop/ui/views/graphics/vector-drawable-resources), 
-for other platforms they copied as is.
-
-#### Image modifiers
-The image filename can contain modifiers in parentheses listed through underscores.
-
-> **orig**
-> 
-> Used for iOS. Marks image as `Original` (similar to `Render As: Original Image` in XCode Assets Manager). 
-Recommended for multicolor images.
-
-> **size**
-> 
-> Applies to bitmaps. Reduces image resolution to specified size.
-> - For Android generate images from mdpi to xxxhdpi (where mdpi is 1:1 in pixels to specified size)
-> - For iOS generate images from @1x to @3x (where @1x is 1:1 in pixels to specified size)
-> - For JVM and JS a single image of specified size is generated.
-
-Filename examples:
-```
-some_hd_image_(100).jpg
-app_logo_(orig).svg
-my_colorful_bitmap_(orig)_(150).png
-```
-Kotlin:
-```kotlin
-MainRes.image.some_hd_image
-MainRes.image.app_logo
-MainRes.image.my_colorful_bitmap
-```
-Swift:
-```swift
-MainRes.shared.image.some_hd_image
-// or MainRes.shared.image.someHdImage if `camelCaseNamesForAppleFramework` enabled
-```
-
-<details>
-  <summary><h3>Why do I see a black/blue box instead of my picture?</h3></summary>
-
-I'm pretty sure your picture is multicolor JPG/SVG with opaque background.  
-This happens because UIKit recolors this image with accent color.
-
-Solution: add (orig) modifier to image filename, e.g.: `my_image_(orig).png`
-</details>
-
-<details>
-  <summary><h3>How to export bitmap from Figma?</h3></summary>
-
-To obtain bundle of PNG images with different resolutions (mdpi-xxxhdpi for Android and @1x-@3x for iOS) do following steps:
-1. Export image from Figma with x4 scale (it matches to the biggest used size — xxxhdpi on Android)
-2. Put it to `libres/images` package
-3. Remember the biggest side value of image represented in Figma
-4. Rename image with the value of the biggest side:  
-**pic.png** -> **pic_(orig)_({side_value}).png** or **pic_({side_value}).png**
-
-Sample:
-Image size in Figma is **240x89**. Final image name is **pic_(orig)_(240).png**
-</details>

gradle.properties

@@ -9,7 +9,7 @@ org.jetbrains.compose.experimental.macos.enabled=true
 org.jetbrains.compose.experimental.wasm.enabled=true
 
 GROUP=io.github.skeptick.libres
-VERSION_NAME=1.2.4
+VERSION_NAME=2.0.0-alpha01
 
 SONATYPE_HOST=CENTRAL_PORTAL