diff --git a/LICENSE b/LICENSE index f9ca1d1..49b9e04 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2020 Ruslan Isamukhametov +Copyright (c) 2020-2023 Ruslan Isamukhametov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index a88aad8..64d3af5 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,48 @@ # go-wiremock +[![GoDoc](https://godoc.org/github.com/wiremock/go-wiremock?status.svg)](http://godoc.org/github.com/wiremock/go-wiremock) [![Actions Status](https://github.com/wiremock/go-wiremock/workflows/build/badge.svg)](https://github.com/wiremock/go-wiremock/actions?query=workflow%3Abuild) [![Go Report Card](https://goreportcard.com/badge/github.com/wiremock/go-wiremock)](https://goreportcard.com/report/github.com/wiremock/go-wiremock) -The simple package to stub HTTP resource using [WireMock admin](http://wiremock.org/docs/api/) + + Go WireMock Logo + + +The Golang client library to stub API resources in [WireMock](https://wiremock.org) using its +[REST API](https://wiremock.org/docs/api/). +The project connects to the instance and allows +setting up stubs and response templating, +or using administrative API to extract observability data. ## Documentation [![GoDoc](https://godoc.org/github.com/wiremock/go-wiremock?status.svg)](http://godoc.org/github.com/wiremock/go-wiremock) +## Compatibility + +The library was tested with the following distributions +of WireMock: + +- WireMock 2.x - standalone deployments, including but not limited to official Docker images, Helm charts and the Java executable +- WireMock 3.x Beta - partial support, some features are + yet to be implemented. Contributions are welcome! +- [WireMock Cloud](https://www.wiremock.io/product) - + proprietary SaaS edition by WireMock Inc. + +Note that the CI pipelines run only against the official community distributions of WireMock. +It may work for custom builds and other distributions. +Should there be any issues, contact their vendors/maintainers. + ## Usage +Launch a standalone Docker instance: + ```shell docker run -it --rm -p 8080:8080 wiremock/wiremock ``` +Connect to it using the client library: + ```go package main @@ -87,4 +115,8 @@ func TestSome(t *testing.T) { wiremockClient.DeleteStub(statusStub) } -``` \ No newline at end of file +``` + +## License + +[MIT License](./LICENSE) diff --git a/docs/images/logo/logo.png b/docs/images/logo/logo.png new file mode 100644 index 0000000..f471627 Binary files /dev/null and b/docs/images/logo/logo.png differ diff --git a/docs/images/logo/opengraph.png b/docs/images/logo/opengraph.png new file mode 100644 index 0000000..cd960a4 Binary files /dev/null and b/docs/images/logo/opengraph.png differ