Skip to content

Commit a06b954

Browse files
committed
docs: minor update to main readme
Signed-off-by: JP-Ellis <josh@jpellis.me>
1 parent 7100c50 commit a06b954

1 file changed

Lines changed: 17 additions & 21 deletions

File tree

README.md

Lines changed: 17 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -7,31 +7,26 @@
77

88
> Reference implementations for the Pact Specification written in Rust
99
10-
This project contains a reference implementation of the [Pact specification](https://github.com/pact-foundation/pact-specification)
11-
written in Rust, often referred to as the Pact Core.
10+
This project contains a reference implementation of the [Pact specification](https://github.com/pact-foundation/pact-specification) written in Rust, often referred to as the Pact Core.
11+
12+
It exposes the core functionality through various crates, as part of the Pact Rust SDK, as well as through FFI (Foreign Function Interface) and CLI (Command Line Interface) for use in other programming languages.
1213

1314
## Usage
1415

1516
### Rust
1617

17-
For Rust projects, you can use the Rust crates from this library in your project directly. Refer to the [Rust project
18-
readme](rust/README.md). Requires minimum Rust 1.71.0.
19-
20-
### Other languages
18+
For Rust projects, you can use the Rust crates from this library in your project directly. Refer to the [Rust project readme](rust/README.md).
2119

22-
#### FFI
20+
### FFI
2321

24-
This project contains dynamic libraries that expose the core functionality through FFI (Foreign Function Interface).
22+
This project contains dynamic libraries that expose the core functionality through a C-compatible FFI (Foreign Function Interface).
2523

26-
For examples:
24+
This project contains a couple of examples which demonstrate how to use the FFI library in a C project, with a focus on showcasing how to call the FFI functions from C:
2725

28-
* [C - Consumer](c/consumer-verification)
29-
* [C - Provider](c/provider-verification)
30-
* [Various Languages](https://github.com/YOU54F/hello_ffi)
26+
* [C - Consumer](c/consumer)
27+
* [C - Provider](c/provider)
3128

32-
For implementations:
33-
34-
[Ecosystem graph](https://docs.pact.io/diagrams/ecosystem#rust-ffi-consumers-goldberg-machine)
29+
Most of the Pact SDKs in other languages make use of this FFI library to provide Pact functionality. You can see this in the [Ecosystem graph](https://docs.pact.io/diagrams/ecosystem#rust-ffi-consumers-goldberg-machine), and the following examples:
3530

3631
* [Javascript via pact-js-core](https://github.com/pact-foundation/pact-js-core)
3732
* [Ruby via pact-ruby-ffi](https://github.com/YOU54F/pact-ruby-ffi)
@@ -43,7 +38,9 @@ For implementations:
4338
* [C++ via pact-cplusplus](https://github.com/pact-foundation/pact-cplusplus)
4439
* [Python via pact-python](https://github.com/pact-foundation/pact-python)
4540

46-
#### CLI
41+
Lastly, you can also refer to [Hello Pact FFI](https://github.com/YOU54F/hello_ffi) for collection of examples in various languages.
42+
43+
### CLI
4744

4845
This project contains code to support exposing the core functionality through CLI (Command Line Interface).
4946

@@ -55,8 +52,7 @@ They are distributed in binary & Docker formats.
5552

5653
## Building
5754

58-
To build the libraries in this project, you need a working Rust environment. Requires minimum Rust 1.59.0.
59-
Refer to the [Rust Guide](https://www.rust-lang.org/learn/get-started).
55+
To build the libraries in this project, you need a working Rust environment. Requires minimum Rust 1.59.0. Refer to the [Rust Guide](https://www.rust-lang.org/learn/get-started).
6056

6157
The build tool used is `cargo`.
6258

@@ -73,7 +69,7 @@ See [CONTRIBUTING](CONTRIBUTING.md) (PRs are always welcome!).
7369

7470
## Documentation
7571

76-
Rust library documentation is published to the Rust documentation site. Refer to the [Rust project README](rust/README.md).
72+
Rust library documentation is published to the Rust documentation site [`docs.rs`](https://docs.rs). Refer to the [Rust project README](rust/README.md).
7773

7874
Additional documentation can be found at the main [Pact website](https://pact.io).
7975

@@ -83,8 +79,8 @@ Join us in slack: [![slack](https://slack.pact.io/badge.svg)](https://slack.pact
8379

8480
or
8581

86-
- Twitter: [@pact_up](https://twitter.com/pact_up)
87-
- Stack Overflow: [stackoverflow.com/questions/tagged/pact](https://stackoverflow.com/questions/tagged/pact)
82+
* Twitter: [@pact_up](https://twitter.com/pact_up)
83+
* Stack Overflow: [stackoverflow.com/questions/tagged/pact](https://stackoverflow.com/questions/tagged/pact)
8884

8985
## Licensing
9086

0 commit comments

Comments
 (0)