Skip to content

Commit de533be

Browse files
committed
docs(runtime): add missing installation sections to runtime API docs
1 parent 57993b2 commit de533be

4 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/runtime/aot-cache.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Detect whether the application is running in AOT training mode or with an AOT cache.
44

5+
## Installation
6+
7+
```kotlin
8+
dependencies {
9+
implementation("io.github.kdroidfilter:nucleus.aot-runtime:<version>")
10+
// Transitive: nucleus.core-runtime is pulled in via `api`
11+
}
12+
```
13+
514
```kotlin
615
import io.github.kdroidfilter.nucleus.aot.runtime.AotRuntime
716
import io.github.kdroidfilter.nucleus.aot.runtime.AotRuntimeMode

docs/runtime/deep-links.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Handle custom URL protocol links (`myapp://action?param=value`).
44

5+
## Installation
6+
7+
```kotlin
8+
dependencies {
9+
implementation("io.github.kdroidfilter:nucleus.core-runtime:<version>")
10+
}
11+
```
12+
513
```kotlin
614
import io.github.kdroidfilter.nucleus.core.runtime.DeepLinkHandler
715
```

docs/runtime/executable-type.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Detect at runtime which installer format was used to package your application.
44

5+
## Installation
6+
7+
```kotlin
8+
dependencies {
9+
implementation("io.github.kdroidfilter:nucleus.core-runtime:<version>")
10+
}
11+
```
12+
513
```kotlin
614
import io.github.kdroidfilter.nucleus.core.runtime.ExecutableRuntime
715
import io.github.kdroidfilter.nucleus.core.runtime.ExecutableType

docs/runtime/single-instance.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
Enforce that only one instance of your application runs at a time.
44

5+
## Installation
6+
7+
```kotlin
8+
dependencies {
9+
implementation("io.github.kdroidfilter:nucleus.core-runtime:<version>")
10+
}
11+
```
12+
513
```kotlin
614
import io.github.kdroidfilter.nucleus.core.runtime.SingleInstanceManager
715
```

0 commit comments

Comments
 (0)