Skip to content

Commit

Permalink
Simplify README and other documentation fixes. (#2571)
Browse files Browse the repository at this point in the history
  • Loading branch information
colinrtwhite authored Oct 18, 2024
1 parent 6c61b3c commit edb5b24
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 21 deletions.
23 changes: 3 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
![Coil](logo.svg)

An image loading library for Android and [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/). Coil is:
An image loading library for [Android](https://www.android.com/) and [Compose Multiplatform](https://www.jetbrains.com/lp/compose-multiplatform/). Coil is:

- **Fast**: Coil performs a number of optimizations including memory and disk caching, downsampling the image, automatically pausing/cancelling requests, and more.
- **Lightweight**: Coil only depends on Kotlin, Coroutines, and Okio and works seamlessly with [Google's R8](https://developer.android.com/build/shrink-code).
Expand All @@ -9,15 +9,11 @@ An image loading library for Android and [Compose Multiplatform](https://www.jet

Coil is an acronym for: **Co**routine **I**mage **L**oader.

Check out Coil's [full documentation here](https://coil-kt.github.io/coil/getting_started/).

Translations: [日本語](README-ja.md), [한국어](README-ko.md), [Русский](README-ru.md), [Svenska](README-sv.md), [Türkçe](README-tr.md), [中文](README-zh.md)

## Quick Start

#### Compose

Import the Compose library and a networking library:
Import the Compose library and a [networking library](https://coil-kt.github.io/coil/network/):

```kotlin
implementation("io.coil-kt.coil3:coil-compose:3.0.0-rc01")
Expand All @@ -33,20 +29,7 @@ AsyncImage(
)
```

#### Views

Import the core library and a networking library:

```kotlin
implementation("io.coil-kt.coil3:coil:3.0.0-rc01")
implementation("io.coil-kt.coil3:coil-network-okhttp:3.0.0-rc01")
```

To load an image into an `ImageView`, use the `load` extension function:

```kotlin
imageView.load("https://example.com/image.jpg")
```
Check out Coil's [full documentation here](https://coil-kt.github.io/coil/getting_started/).

## License

Expand Down
2 changes: 1 addition & 1 deletion coil-network-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ implementation("io.coil-kt.coil3:coil-network-ktor2:3.0.0-rc01")
implementation("io.coil-kt.coil3:coil-network-ktor3:3.0.0-rc01")
```

And that's it. Once, imported network URLs like `https://www.example.com/image.jpg` will automatically be supported.
And that's it. Once imported, network URLs like `https://www.example.com/image.jpg` will automatically be supported.

However, if you depend on `coil-network-ktor2` or `coil-network-ktor3` you need to import a [Ktor engine](https://ktor.io/docs/client-engines.html) for each platform (except Javascript). Here's a quickstart set of engines:

Expand Down

0 comments on commit edb5b24

Please sign in to comment.