Skip to content

Commit

Permalink
docs: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
warnyul committed Apr 30, 2024
1 parent e058636 commit 3649c33
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ in-memory environment.
* **Parallel Execution:** Parallel test execution is not yet supported. We're actively working on
addressing this limitation in future releases.
* **Configuration:**
* Robolectric `@Config`'s sdk parameter annotation can only be set on most outer test class.
* `@ResourcesMode`, `@LooperMode`, `GraphicsMode` annotations can only be set on most outer test class.
* Robolectric `@Config`'s sdk parameter annotation can only be set on most outer test class.
* `@ResourcesMode`, `@LooperMode`, `GraphicsMode` annotations can only be set on most outer test
class.
* **Experimental Status:** This extension is still under development, and its API might change in
future versions.

## Installation

1. Add the Gradle Plugin Portal and Maven Central and Google's Maven repository to your project's `settings.gradle` file:
1. Add the Gradle Plugin Portal and Maven Central and Google's Maven repository to your project'
s `settings.gradle` file:

<details open>
<summary>Kotlin</summary>
Expand Down Expand Up @@ -75,7 +77,7 @@ dependencyResolutionManagement {

```kotlin
plugins {
id("tech.apter.junit5.jupiter.robolectric-extension-gradle-plugin")
id("tech.apter.junit5.jupiter.robolectric-extension-gradle-plugin") version ("<latest.release>")
}
```

Expand All @@ -86,7 +88,7 @@ plugins {

```groovy
plugins {
id 'tech.apter.junit5.jupiter.robolectric-extension-gradle-plugin'
id 'tech.apter.junit5.jupiter.robolectric-extension-gradle-plugin' version '<latest.release>'
}
```

Expand Down Expand Up @@ -116,8 +118,8 @@ plugins {
</details>

2. Utilize the standard JUnit 5 annotations (`@Test`, `@BeforeEach`, `@AfterEach`, etc.) within your
test methods. You
could also use `org.jetbrains.kotlin:kotlin-test-junit5` package if you want to.
test methods. You could also use `org.jetbrains.kotlin:kotlin-test-junit5` package if you want
to.

<details open>
<summary>Kotlin</summary>
Expand Down

0 comments on commit 3649c33

Please sign in to comment.