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 87da473 commit 2c2ba1b
Showing 1 changed file with 18 additions and 8 deletions.
26 changes: 18 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
# Watermill Firestore Pub/Sub [![CI Status](https://github.com/ThreeDotsLabs/watermill-firestore/actions/workflows/master.yml/badge.svg)](https://github.com/ThreeDotsLabs/watermill-firestore/actions/workflows/master.yml) [![Go Reference](https://pkg.go.dev/badge/github.com/ThreeDotsLabs/watermill-firestore.svg)][goreference]
# Watermill Firestore Pub/Sub
<img align="right" width="200" src="https://threedots.tech/watermill-io/watermill-logo.png">

This is a Pub/Sub for the [Watermill][watermill] project which uses the
[Firestore][firestore] database.
[![CI Status](https://github.com/ThreeDotsLabs/watermill-firestore/actions/workflows/master.yml/badge.svg)](https://github.com/ThreeDotsLabs/watermill-firestore/actions/workflows/master.yml)
[![Go Report Card](https://goreportcard.com/badge/github.com/ThreeDotsLabs/watermill-firestore)](https://goreportcard.com/report/github.com/ThreeDotsLabs/watermill-firestore)

All Pub/Sub implementations can be found at [https://watermill.io/pubsubs/](https://watermill.io/pubsubs/).
This is Pub/Sub for the [Watermill](https://watermill.io/) project.
It uses the [Firestore](https://firebase.google.com/docs/firestore) database.

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 @@ -23,7 +28,12 @@ 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.

[watermill]: https://watermill.io/
[firestore]: https://firebase.google.com/docs/firestore
[actions]: https://github.com/ThreeDotsLabs/watermill-firestore/actions
[goreference]: https://pkg.go.dev/github.com/ThreeDotsLabs/watermill-firestore
## 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)

0 comments on commit 2c2ba1b

Please sign in to comment.