Skip to content

Commit

Permalink
docs: add links to cli docs and pact core terminology [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
YOU54F committed Nov 26, 2024
1 parent 903ed08 commit 3aed6bd
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,11 @@
[![Pact-Rust FFI Build](https://github.com/pact-foundation/pact-reference/actions/workflows/build-ffi.yml/badge.svg)](https://github.com/pact-foundation/pact-reference/actions/workflows/build-ffi.yml)

# Pact Reference Implementation
> Reference implementations for Pact Specification written in Rust

This project contains a reference implementation of the [Pact specifications](https://github.com/pact-foundation/pact-specification)
written in Rust, as well as example projects in JavaScript and C (and a few others) that use the mock server library.
> Reference implementations for the Pact Specification written in Rust
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.

## Usage

Expand All @@ -18,16 +19,20 @@ readme](rust/README.md). Requires minimum Rust 1.71.0.

### Other languages

#### FFI

This project contains dynamic libraries that expose the core functionality through FFI (Foreign Function Interface).

For examples:

* [C - Consumer](c/consumer-verification)
* [C - Provider](c/provider-verification)
* [Various Languages](https://github.com/YOU54F/hello_ffi)

For implementations:

[Ecosystem graph](https://docs.pact.io/diagrams/ecosystem#rust-ffi-consumers-goldberg-machine)

* [Javascript via pact-js-core](https://github.com/pact-foundation/pact-js-core)
* [Ruby via pact-ruby-ffi](https://github.com/YOU54F/pact-ruby-ffi)
* [PHP via pact-php](https://github.com/pact-foundation/pact-php)
Expand All @@ -38,6 +43,16 @@ For implementations:
* [C++ via pact-cplusplus](https://github.com/pact-foundation/pact-cplusplus)
* [Python via pact-python](https://github.com/pact-foundation/pact-python)

#### CLI

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

* [pact_mock_server_cli](https://github.com/pact-foundation/pact-core-mock-server/tree/main/pact_mock_server_cli)
* [pact_verifier_cli](https://github.com/pact-foundation/pact-reference/tree/master/rust/pact_verifier_cli)
* [pact-stub-server-cli](https://github.com/pact-foundation/pact-stub-server)

They are distributed in binary & Docker formats.

## Building

To build the libraries in this project, you need a working Rust environment. Requires minimum Rust 1.59.0.
Expand Down

0 comments on commit 3aed6bd

Please sign in to comment.