Skip to content

Commit 4f66547

Browse files
committed
Improve README: Add maven dependency and elaborate on introduction
1 parent 7a50ffa commit 4f66547

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,18 @@ TestParameterInjector
33

44
## Introduction
55

6+
`TestParameterInjector` is a JUnit4 test runner that runs its test methods for
7+
different combinations of field/parameter values.
8+
69
Parameterized tests are a great way to avoid code duplication between tests and
710
promote high test coverage for data-driven tests.
811

12+
There are a lot of alternative parameterized test frameworks, such as
13+
[junit.runners.Parameterized](https://github.com/junit-team/junit4/wiki/parameterized-tests)
14+
and [JUnitParams](https://github.com/Pragmatists/JUnitParams). We believe
15+
`TestParameterInjector` is an improvement of those because it is more powerful
16+
and simpler to use.
17+
918
## Getting started
1019

1120
To start using `TestParameterInjector` right away, copy the following snippet:
@@ -31,6 +40,21 @@ public class MyTest {
3140
}
3241
```
3342

43+
And add the following dependency to your `.pom` file:
44+
45+
```xml
46+
<dependency>
47+
<groupId>com.google.testparameterinjector</groupId>
48+
<artifactId>test-parameter-injector</artifactId>
49+
<version>1.0-rc1</version>
50+
</dependency>
51+
```
52+
53+
or see [this maven.org
54+
page](https://search.maven.org/artifact/com.google.testparameterinjector/test-parameter-injector)
55+
for instructions for other build tools.
56+
57+
3458
## Basics
3559

3660
### `@TestParameter` for testing all combinations

0 commit comments

Comments
 (0)