Skip to content

Commit

Permalink
Update readme and changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
mcrumm committed Sep 7, 2023
1 parent 1ef04ca commit e389fab
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 5 deletions.
5 changes: 3 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## Development version
## [Unreleased]

### Changed

Expand Down Expand Up @@ -186,7 +186,8 @@ This version moves Cloud PubSub from Tesla to Finch, so read the notes below and
- `BroadwayCloudPubSub.Token` - A generic behaviour to implement token authentication for Pub/Sub clients.
- `BroadwayCloudPubSub.GothToken` - Default token provider used by `BroadwayCloudPubSub.Producer`.

[Unreleased]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.7.1...HEAD
[Unreleased]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.8.0...HEAD
[0.8.0]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.7.1...v0.8.0
[0.7.1]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.7.0...v0.7.1
[0.7.0]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.6.2...v0.7.0
[0.6.3]: https://github.com/dashbitco/broadway_cloud_pub_sub/compare/v0.6.2...v0.6.3
Expand Down
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This project provides:

* `BroadwayCloudPubSub.Producer` - A GenStage producer that continuously receives messages from a Pub/Sub subscription acknowledges them after being successfully processed.
* `BroadwayCloudPubSub.Client` - A generic behaviour to implement Pub/Sub clients.
* `BroadwayCloudPubSub.GoogleApiClient` - Default REST client used by `BroadwayCloudPubSub.Producer`.
* `BroadwayCloudPubSub.PullClient` - Default REST client used by `BroadwayCloudPubSub.Producer`.

## Installation

Expand All @@ -19,8 +19,8 @@ Add `:broadway_cloud_pub_sub` to the list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:broadway_cloud_pub_sub, "~> 0.7.0"},
{:goth, "~> 1.0"}
{:broadway_cloud_pub_sub, "~> 0.8.0"},
{:goth, "~> 1.3"}
]
end
```
Expand All @@ -36,6 +36,7 @@ Broadway.start_link(MyBroadway,
name: MyBroadway,
producer: [
module: {BroadwayCloudPubSub.Producer,
goth: MyGoth,
subscription: "projects/my-project/subscriptions/my-subscription"
}
]
Expand Down

0 comments on commit e389fab

Please sign in to comment.