Skip to content

Commit

Permalink
fix links in README
Browse files Browse the repository at this point in the history
  • Loading branch information
@jordond
jordond committed Sep 18, 2023
1 parent e1dc9c0 commit 230c6a1
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 20 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ jobs:
instrumented:
strategy:
matrix:
api-level: [ 24, 29, 31 ]
api-level: [ 24, 29, 31, 34 ]
runs-on: macos-latest
name: Test API ${{ matrix.api-level }}
needs: verify
Expand Down
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ Since the generation of the dominant color is an asynchronous operation that can
the results of the operation using the `DominantColorState.result` object.

For more examples of getting a dominant color see
the [demo app](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/dominant)
the [demo app](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/dominant)

### Generate a color Palette

Expand Down Expand Up @@ -188,20 +188,20 @@ Since the generation of the dominant color is an asynchronous operation that can
the results of the operation using the `DominantColorState.result` object.

For more examples of generating a Palette see
the [demo app](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/palette)
the [demo app](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/palette)

### Sources

In order to generate a color palette, you must first have an `ImageBitmap` object. This library
provides some extensions artifacts for some popular sources.

| Artifact | Library | Loader | Input Class | Demo |
|:--------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------|-------------------|-------------|---------------------------------------------------------------------------------------------------------------------------|
| [`extensions-base64`](extensions-base64/README.md) | N/A | `Base64Loader` | `String` | [`Base64DemoScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/dominant/Base64DemoScreen.kt) |
| [`extensions-bytearray`](extensions-bytearray/README.md) | N/A | `ByteArrayLoader` | `ByteArray` | N/A |
| [`extensions-libres`](extensions-libres/README.md) | [libres](https://github.com/Skeptick/libres) | `LibresLoader` | `Image` | [`LibresPaletteScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/palette/LibresPaletteScreen.kt) |
| [`extensions-network`](extensions-network/README.md) | [ktor](https://github.com/ktorio/ktor) | `NetworkLoader` | `Url` | [`NetworkDemoScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/dominant/NetworkDemoScreen.kt) |
| [`extensions-resources`](extensions-resources/README.md) | [Compose Multiplatform Resources](https://github.com/JetBrains/compose-multiplatform/tree/master/components/resources) | `ResourceLoader` | `Resource` | [`ResourcesPaletteScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/palette/ResourcesPaletteScreen.kt) |
| Artifact | Library | Loader | Input Class | Demo |
|:--------------------------------------------------------:|------------------------------------------------------------------------------------------------------------------------|-------------------|-------------|------------------------------------------------------------------------------------------------------------------------|
| [`extensions-base64`](extensions-base64/README.md) | N/A | `Base64Loader` | `String` | [`Base64DemoScreen`](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/dominant/Base64DemoScreen.kt) |
| [`extensions-bytearray`](extensions-bytearray/README.md) | N/A | `ByteArrayLoader` | `ByteArray` | N/A |
| [`extensions-libres`](extensions-libres/README.md) | [libres](https://github.com/Skeptick/libres) | `LibresLoader` | `Image` | [`LibresPaletteScreen`](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/palette/LibresPaletteScreen.kt) |
| [`extensions-network`](extensions-network/README.md) | [ktor](https://github.com/ktorio/ktor) | `NetworkLoader` | `Url` | [`NetworkDemoScreen`](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/dominant/NetworkDemoScreen.kt) |
| [`extensions-resources`](extensions-resources/README.md) | [Compose Multiplatform Resources](https://github.com/JetBrains/compose-multiplatform/tree/master/components/resources) | `ResourceLoader` | `Resource` | [`ResourcesPaletteScreen`](demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/palette/ResourcesPaletteScreen.kt) |

Each of these extensions provides a `ImageBitmapLoader` object that can be used to generate
an `ImageBitmap` from the input class. For example, the `NetworkLoader` can be used to generate
Expand Down
5 changes: 3 additions & 2 deletions extensions-base64/README.md
View file
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Base64 Extensions

This extension provides `Base64Loader` a `ImageBitmapLoader` for loading base64 encoded images to a `ImageBitmap`.
This extension provides `Base64Loader` a `ImageBitmapLoader` for loading base64 encoded images to
a `ImageBitmap`.

| Loader | Input Class | Demo |
|----------------|-------------|----------------------------------------------------------------------------------------------------------------|
| `Base64Loader` | `String` | [`Base64DemoScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/dominant/Base64DemoScreen.kt) |
| `Base64Loader` | `String` | [`Base64DemoScreen`](../demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/dominant/Base64DemoScreen.kt) |

# Setup

Expand Down
2 changes: 1 addition & 1 deletion extensions-libres/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ loading [Libres](https://github.com/Skeptick/libres) `Image` objects.

| Library | Loader | Input Class | Demo |
|----------------------------------------------|----------------|-------------|---------------------------------------------------------------------------------------------------------------------|
| [libres](https://github.com/Skeptick/libres) | `LibresLoader` | `Image` | [`LibresPaletteScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/palette/LibresPaletteScreen.kt) |
| [libres](https://github.com/Skeptick/libres) | `LibresLoader` | `Image` | [`LibresPaletteScreen`](../demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/palette/LibresPaletteScreen.kt) |

## Setup

Expand Down
6 changes: 3 additions & 3 deletions extensions-network/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

This extension provides `Network` a `ImageBitmapLoader` for loading images from a URL.

| Library | Loader | Input Class | Demo |
|------------------------------------------------------|----------------------------------------|-----------------|-------|
| [`extensions-network`](extensions-network/README.md) | [ktor](https://github.com/ktorio/ktor) | `NetworkLoader` | `Url` | [`NetworkDemoScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/dominant/NetworkDemoScreen.kt) |
| Library | Loader | Input Class | Demo |
|----------------------------------------|-----------------|-------------|------------------------------------------------------------------------------------------------------------------|
| [ktor](https://github.com/ktorio/ktor) | `NetworkLoader` | `Url` | [`NetworkDemoScreen`](../demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/dominant/NetworkDemoScreen.kt) |

## Setup

Expand Down
11 changes: 7 additions & 4 deletions extensions-resources/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,12 @@
This extension provides `ResourceLoader` a `ImageBitmapLoader` for images using Compose
Multiplatform Resources.

| Library | Loader | Input Class | Demo |
|----------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|------------------|------------|
| [`extensions-resources`](extensions-resources/README.md) | [Compose Multiplatform Resources](https://github.com/JetBrains/compose-multiplatform/tree/master/components/resources) | `ResourceLoader` | `Resource` | [`ResourcesPaletteScreen`](demo/composeApp/src/commonMain/kotlin/dev/jordond/kmpalette/palette/ResourcesPaletteScreen.kt) |
| Library | Loader | Input Class | Demo |
|------------------------------------------------------------------------------------------------------------------------|------------------|-------------|---------------------------------------------------------------------------------------------------------------------------|
| [Compose Multiplatform Resources](https://github.com/JetBrains/compose-multiplatform/tree/master/components/resources) | `ResourceLoader` | `Resource` | [`ResourcesPaletteScreen`](../demo/composeApp/src/commonMain/kotlin/com/kmpalette/demo/palette/ResourcesPaletteScreen.kt) |

Each of these extensions provides a `ImageBitmapLoader` object that can be used to generate
an `ImageBitmap` from the input class. For example, the `NetworkLoader` can be used to generate

## Setup

Expand Down Expand Up @@ -34,7 +37,7 @@ android {
res.srcDirs("src/androidMain/resources")
resources.srcDirs("src/commonMain/resources")
}

// ...
}
```
Expand Down

0 comments on commit 230c6a1

Please sign in to comment.