From 0275c57c6ac978ccfed66f291baf6704985b5e6d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mi=C5=82osz=20Sm=C3=B3=C5=82ka?= Date: Mon, 28 Oct 2024 10:38:58 +0100 Subject: [PATCH] Update README.md (by Terraform) --- README.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..43d528c --- /dev/null +++ b/README.md @@ -0,0 +1,39 @@ +# Watermill Amazon SQS/SNS Pub/Sub + + +[![CI Status](https://github.com/ThreeDotsLabs/watermill-aws/actions/workflows/master.yml/badge.svg)](https://github.com/ThreeDotsLabs/watermill-aws/actions/workflows/master.yml) +[![Go Report Card](https://goreportcard.com/badge/github.com/ThreeDotsLabs/watermill-aws)](https://goreportcard.com/report/github.com/ThreeDotsLabs/watermill-aws) + +This is Pub/Sub for the [Watermill](https://watermill.io/) project. +It uses the [Amazon SQS](https://aws.amazon.com/sqs/) and [Amazon SNS](https://aws.amazon.com/sns/) services. + +See [DEVELOPMENT.md](./DEVELOPMENT.md) for more information about running and testing. + +Watermill is a Go library for working efficiently with message streams. It is intended +for building event driven applications, enabling event sourcing, RPC over messages, +sagas and basically whatever else comes to your mind. You can use conventional pub/sub +implementations like Kafka or RabbitMQ, but also HTTP or MySQL binlog if that fits your use case. + +All Pub/Sub implementations can be found at [https://watermill.io/pubsubs/](https://watermill.io/pubsubs/). + +Documentation: https://watermill.io/ + +Getting started guide: https://watermill.io/docs/getting-started/ + +Issues: https://github.com/ThreeDotsLabs/watermill/issues + +## Contributing + +All contributions are very much welcome. If you'd like to help with Watermill development, +please see [open issues](https://github.com/ThreeDotsLabs/watermill/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+) +and submit your pull request via GitHub. + +## Support + +If you didn't find the answer to your question in [the documentation](https://watermill.io/), feel free to ask us directly! + +Please join us on the `#watermill` channel on the [Three Dots Labs Discord](https://discord.gg/QV6VFg4YQE). + +## License + +[MIT License](./LICENSE)