Skip to content

Commit

Permalink
Update README.md (by Terraform)
Browse files Browse the repository at this point in the history
  • Loading branch information
m110 committed Aug 30, 2024
1 parent 3d0c286 commit 59d9adc
Showing 1 changed file with 6 additions and 18 deletions.
24 changes: 6 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# Watermill Google Cloud Pub/Sub
# Watermill Google Cloud Pub/Sub Pub/Sub
<img align="right" width="200" src="https://threedots.tech/watermill-io/watermill-logo.png">

[![CI Status](https://github.com/ThreeDotsLabs/watermill-googlecloud/actions/workflows/master.yml/badge.svg)](https://github.com/ThreeDotsLabs/watermill-googlecloud/actions/workflows/master.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/ThreeDotsLabs/watermill-googlecloud)](https://goreportcard.com/report/github.com/ThreeDotsLabs/watermill-googlecloud)

This is Pub/Sub for the [Watermill](https://watermill.io/) project.
It uses the [Google Cloud Pub/Sub](https://cloud.google.com/pubsub) service.

All Pub/Sub implementations can be found at [https://watermill.io/pubsubs/](https://watermill.io/pubsubs/).
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/
Expand All @@ -25,26 +28,11 @@ All contributions are very much welcome. If you'd like to help with Watermill de
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.

### Testing Locally

The tests expect a running instance of PubSub. You can run the emulator specified in the `docker-compose.yml`, then set the correct env variable by running the following:
```
make up
PUBSUB_EMULATOR_HOST=localhost:8085 make test
```

Running one test:

```
make up
PUBSUB_EMULATOR_HOST=localhost:8085 go test -v ./... -run TestPublishSubscribe/TestContinueAfterSubscribeClose
```

## 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 [Gophers slack](https://gophers.slack.com/): You can get an invite [here](https://gophersinvite.herokuapp.com/).
Please join us on the `#watermill` channel on the [Three Dots Labs Discord](https://discord.gg/QV6VFg4YQE).

## License

Expand Down

0 comments on commit 59d9adc

Please sign in to comment.