Skip to content

Commit

Permalink
Update readme re pro* templates
Browse files Browse the repository at this point in the history
  • Loading branch information
bartelink committed Jun 19, 2019
1 parent 8f3274d commit d470458
Showing 1 changed file with 17 additions and 6 deletions.
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,16 @@ This repo hosts the source for Jet's [`dotnet new`](https://docs.microsoft.com/e

## [Propulsion](https://github.com/jet/propulsion) related

- [`eqxprojector`](equinox-projector/README.md) - Boilerplate for a CosmosDb ChangeFeedProcessor (typically unrolling events from `Equinox.Cosmos` stores using `Propulsion.Cosmos`)); Optional projection to Apache Kafka and associated consumer logic using [`Propulsion.Kafka`](https://github.com/jet/propulsion).
- [`eqxsync`](equinox-sync/README.md) - Boilerplate for a console app that that syncs events between [`Equinox.Cosmos` and `Equinox.EventStore`](https://github.com/jet/equinox) using the [relevant `Propulsion`.* libraries](https://github.com/jet/propulsion), filtering/enriching/mapping Events as necessary.
- [`proProjector`](propulsion-projector/README.md) - Boilerplate for an Azure CosmosDb ChangeFeedProcessor (typically unrolling events from `Equinox.Cosmos` stores using `Propulsion.Cosmos`)

`-k` adds Optional projection to Apache Kafka using [`Propulsion.Kafka`](https://github.com/jet/propulsion).

- [`proConsumer`](propulsion-consumer/README.md) - Boilerplate for an Apache Kafka Consumer using [`Propulsion.Kafka`](https://github.com/jet/propulsion).

- [`proSync`](propulsion-sync/README.md) - Boilerplate for a console app that that syncs events between [`Equinox.Cosmos` and `Equinox.EventStore` stores](https://github.com/jet/equinox) using the [relevant `Propulsion`.* libraries](https://github.com/jet/propulsion), filtering/enriching/mapping Events as necessary.

## Walkthrough

## Walkthroughs
As dictated by [the design of dotnet's templating mechanism](https://github.com/dotnet/templating/), consumption is ultimately via the .NET Core SDK's `dotnet new` CLI facility and/or associated facilities in Visual Studio, Rider etc.

To use from the command line, the outline is:
Expand All @@ -34,10 +40,15 @@ To use from the command line, the outline is:
# see readme.md in the generated code for further instructions regarding the TodoBackend the above -t switch above triggers the inclusion of
start readme.md

# ... to add a Projector and a Consumer
# ... to add a Projector
md -p ../tools/My.Tools.Projector | Set-Location
# (-k emits to Kafka and hence implies having a Consumer)
dotnet new eqxprojector -k
dotnet new proProjector -k
start README.md

# ... to add a Consumer (proProjector -k emits to Kafka and hence implies having a Consumer)
md -p ../../My.Consumer | Set-Location
dotnet new proConsumer -k
start README.md

# ... to add a Testbed
Expand All @@ -55,7 +66,7 @@ To use from the command line, the outline is:
# ... to add a Sync tool
md -p ../tools/My.Tools.Sync | Set-Location
# (-m includes an example of how to upconvert from similar event-sourced representations in an existing store)
dotnet new eqxsync -m
dotnet new proSync -m
start Sync/README.md

## CONTRIBUTING
Expand Down

0 comments on commit d470458

Please sign in to comment.