Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xethorn authored Sep 16, 2023
1 parent 9532bef commit 800a2f0
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# kfactories
[![build](https://github.com/cashapp/kfactories/actions/workflows/build.yaml/badge.svg?branch=main)](https://github.com/cashapp/kfactories/actions/workflows/build.yaml)
[![Maven Central](https://img.shields.io/maven-central/v/app.cash.kfactories/kfactories)](https://mvnrepository.com/artifact/app.cash.kfactories/kfactories)

Set of factories and utils to run an
effective and [property-based testing](https://www.infoq.com/presentations/property-based-testing/)
Expand All @@ -13,6 +15,14 @@ least one of these fields is required. As you run the tests, you will always get
combination that represents a valid customer. For example, the first run might have all customer
fields set. Another run might only have the email.

## Installation
If you are using Gradle, simply add the dependency:
```
testImplementation("app.cash.kfactories:kfactories:1.0.0")
```

For other installations, see instructions on [maven][1].

## Motivations

At Square, we use resources and objects that can have very complex states.
Expand Down Expand Up @@ -217,3 +227,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```

[1]:https://mvnrepository.com/artifact/app.cash.kfactories/kfactories/1.0.0

0 comments on commit 800a2f0

Please sign in to comment.