Skip to content

Commit 62a9ddd

Browse files
author
Ronald Holshausen
committed
small tweak to the docs
1 parent d0fc19e commit 62a9ddd

File tree

1 file changed

+41
-16
lines changed

1 file changed

+41
-16
lines changed

README.md

Lines changed: 41 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -22,38 +22,47 @@ From the [Ruby Pact website](https://github.com/realestate-com-au/pact):
2222
* Twitter: [@pact_up](https://twitter.com/pact_up)
2323
* Google users group: https://groups.google.com/forum/#!forum/pact-support
2424

25-
## I Use Scala and Specs 2
25+
## Service Consumers
26+
27+
Pact-JVM has a number of ways you can write your service consumer tests.
28+
29+
### I Use Scala and Specs 2
2630

2731
You want to look at: [pact-jvm-consumer-specs2](pact-jvm-consumer-specs2)
2832

29-
## I Use Java
33+
### I Use Java
3034

3135
You want to look at: [pact-jvm-consumer-junit](pact-jvm-consumer-junit)
3236

33-
## I Use Groovy or Grails
37+
### I Use Groovy or Grails
3438

3539
You want to look at: [pact-jvm-consumer-groovy](pact-jvm-consumer-groovy) or [pact-jvm-consumer-junit](pact-jvm-consumer-junit)
3640

37-
## I Use some other jvm language or test framework (clojure etc)
41+
### I Use some other jvm language or test framework (clojure etc)
3842

3943
You want to look at: [Pact Consumer](pact-jvm-consumer)
4044

41-
## I am writing a provider and want to run pacts
45+
## Service Providers
46+
47+
Once you have run your consumer tests, you will have generated some Pact files. You can then verify your service providers
48+
with these files.
49+
50+
### I am writing a provider and want to verify pacts
4251

4352
You want to look at: [pact sbt plugin](pact-jvm-provider-sbt)
4453

45-
## I want to run pacts but don't want to use sbt
54+
### I want to run pacts but don't want to use sbt
4655

4756
You want to look at: [pact-jvm-provider](pact-jvm-provider)
4857

49-
## I Use Ruby
58+
### I Use Ruby
5059
The pact-jvm libraries are pure jvm technologies and do not have any native dependencies.
5160

5261
However if you have a ruby provider, the json produced by this library is compatible with the ruby pact library.
5362

5463
You'll want to look at: [pact](https://github.com/realestate-com-au/pact)
5564

56-
## I Use something completely different
65+
### I Use something completely different
5766

5867
There's a limit to how much we can help, however check out [pact-jvm-server](pact-jvm-server)
5968

@@ -62,7 +71,7 @@ There's a limit to how much we can help, however check out [pact-jvm-server](pac
6271
You want to look at:
6372
[Pact Broker](https://github.com/bethesque/pact_broker)
6473

65-
Which is a project that aims at providing tooling to coordinate pact generation and delivery between projects
74+
Which is a project that aims at providing tooling to coordinate pact generation and delivery between projects.
6675

6776
## I want to contribute
6877

@@ -72,16 +81,32 @@ Which is a project that aims at providing tooling to coordinate pact generation
7281
4. Push to the branch (`git push origin my-new-feature`)
7382
5. Create new Pull Request
7483

75-
You can publish pacts locally using:
84+
## Building the library
85+
86+
Most of pact-jvm is written in Scala. You can build it using SBT (the old way). We are moving the build to Gradle,
87+
so you can build it with that too.
88+
89+
To build the libraries:
90+
91+
$ sbt clean test install
7692

77-
```
78-
sbt clean test publishLocal
79-
```
93+
or
94+
95+
$ ./gradlew clean build
96+
97+
You can publish pacts to your local maven repo using:
98+
99+
$ sbt clean test publishLocal
100+
101+
or
102+
103+
$ ~/.gradlew clean install
80104

81105
To publish to a nexus repo, change the url in project/Build.scala then run:
82106

83-
```
84-
sbt clean test publish
85-
```
107+
$ sbt clean test publish
108+
109+
or
110+
$ ./gradlew clean check uploadArchives
86111

87112
You will need to be added to the nexus project to be able to do this.

0 commit comments

Comments
 (0)