Skip to content

Commit ddaa59b

Browse files
committed
doc: add more minor doc improvements and links
1 parent d410b90 commit ddaa59b

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

README.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,13 @@ TestProcesses enables managing one or more of these "test processes" for your te
6262

6363
## Installation
6464

65-
Add TestProcesses to your project's dependencies by declaring `io.github.netmikey.testprocesses:testprocesses-core` as a test-compile-time dependency:
65+
TestProcesses is available as library in [Maven Central](https://search.maven.org/search?q=g:io.github.netmikey.testprocesses). Add TestProcesses to your project's dependencies by declaring a test-compile-time dependency:
6666

6767
```gradle
68+
repositories {
69+
mavenCentral()
70+
}
71+
6872
dependencies {
6973
testImplementation("io.github.netmikey.testprocesses:testprocesses-core:1.0.0")
7074
}
@@ -145,24 +149,27 @@ Using the `@TestProcess` annotation wil have TestProcesses start the targetted `
145149
If you need more control over when a test process is stopped and/or restarted, you can specify that in the annotation:
146150

147151
```java
148-
// The test process will be stopped immediately after this test method
152+
// The test process will be stopped immediately
153+
// after this test method
149154
@TestProcess(
150155
beanClass = MyTestProcess.class,
151156
stopStrategy = StopStrategy.STOP_AFTER_TEST)
152157

153-
// Even if the test process is already running, stop and restart it before starting this test
158+
// Even if the test process is already running,
159+
// stop and restart it before starting this test
154160
@TestProcess(
155161
beanClass = MyTestProcess.class,
156162
startStrategy = StartStrategy.REQUIRE_RESTART)
157163

158-
// Make sure to (re-)start the test process before this test and to stop it immediately after this test
164+
// Make sure to (re-)start the test process before
165+
// this test and to stop it immediately after this test
159166
@TestProcess(
160167
beanClass = MyTestProcess.class,
161168
startStrategy = StartStrategy.REQUIRE_RESTART,
162169
stopStrategy = StopStrategy.STOP_AFTER_TEST)
163170
```
164171

165-
For even more fine-grained control, you will need to use the API.
172+
For even more fine-grained control, you will need to [use the API](#using-the-api).
166173

167174

168175
### Test process identifiers
@@ -231,7 +238,7 @@ public class MyTest {
231238
}
232239
```
233240

234-
For more examples, see the functional tests in the `testprocesses-core` module.
241+
For more examples, see the [functional tests](https://github.com/netmikey/testprocesses/tree/main/testprocesses-core/src/test/java/io/github/netmikey/testprocesses/functional) in the `testprocesses-core` module.
235242

236243

237244
## Limitations

0 commit comments

Comments
 (0)