Skip to content

Commit 7ddf1a2

Browse files
Add logo to the documentation page, note compatibility (#25)
1 parent 2cb62cf commit 7ddf1a2

File tree

4 files changed

+35
-3
lines changed

4 files changed

+35
-3
lines changed

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020 Ruslan Isamukhametov
3+
Copyright (c) 2020-2023 Ruslan Isamukhametov
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,48 @@
11
# go-wiremock
22

3+
[![GoDoc](https://godoc.org/github.com/wiremock/go-wiremock?status.svg)](http://godoc.org/github.com/wiremock/go-wiremock)
34
[![Actions Status](https://github.com/wiremock/go-wiremock/workflows/build/badge.svg)](https://github.com/wiremock/go-wiremock/actions?query=workflow%3Abuild)
45
[![Go Report Card](https://goreportcard.com/badge/github.com/wiremock/go-wiremock)](https://goreportcard.com/report/github.com/wiremock/go-wiremock)
56

6-
The simple package to stub HTTP resource using [WireMock admin](http://wiremock.org/docs/api/)
7+
<a href="https://go.wiremock.org" target="_blank">
8+
<img width="128px" align="right" src="docs/images/logo/logo.png" alt="Go WireMock Logo"/>
9+
</a>
10+
11+
The Golang client library to stub API resources in [WireMock](https://wiremock.org) using its
12+
[REST API](https://wiremock.org/docs/api/).
13+
The project connects to the instance and allows
14+
setting up stubs and response templating,
15+
or using administrative API to extract observability data.
716

817
## Documentation
918

1019
[![GoDoc](https://godoc.org/github.com/wiremock/go-wiremock?status.svg)](http://godoc.org/github.com/wiremock/go-wiremock)
1120

21+
## Compatibility
22+
23+
The library was tested with the following distributions
24+
of WireMock:
25+
26+
- WireMock 2.x - standalone deployments, including but not limited to official Docker images, Helm charts and the Java executable
27+
- WireMock 3.x Beta - partial support, some features are
28+
yet to be implemented. Contributions are welcome!
29+
- [WireMock Cloud](https://www.wiremock.io/product) -
30+
proprietary SaaS edition by WireMock Inc.
31+
32+
Note that the CI pipelines run only against the official community distributions of WireMock.
33+
It may work for custom builds and other distributions.
34+
Should there be any issues, contact their vendors/maintainers.
35+
1236
## Usage
1337

38+
Launch a standalone Docker instance:
39+
1440
```shell
1541
docker run -it --rm -p 8080:8080 wiremock/wiremock
1642
```
1743

44+
Connect to it using the client library:
45+
1846
```go
1947
package main
2048

@@ -87,4 +115,8 @@ func TestSome(t *testing.T) {
87115

88116
wiremockClient.DeleteStub(statusStub)
89117
}
90-
```
118+
```
119+
120+
## License
121+
122+
[MIT License](./LICENSE)

docs/images/logo/logo.png

149 KB
Loading

docs/images/logo/opengraph.png

91.6 KB
Loading

0 commit comments

Comments
 (0)