Skip to content

Commit d470458

Browse files
committed
Update readme re pro* templates
1 parent 8f3274d commit d470458

File tree

1 file changed

+17
-6
lines changed

1 file changed

+17
-6
lines changed

README.md

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,16 @@ This repo hosts the source for Jet's [`dotnet new`](https://docs.microsoft.com/e
1010

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

13-
- [`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).
14-
- [`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.
13+
- [`proProjector`](propulsion-projector/README.md) - Boilerplate for an Azure CosmosDb ChangeFeedProcessor (typically unrolling events from `Equinox.Cosmos` stores using `Propulsion.Cosmos`)
14+
15+
`-k` adds Optional projection to Apache Kafka using [`Propulsion.Kafka`](https://github.com/jet/propulsion).
16+
17+
- [`proConsumer`](propulsion-consumer/README.md) - Boilerplate for an Apache Kafka Consumer using [`Propulsion.Kafka`](https://github.com/jet/propulsion).
18+
19+
- [`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.
20+
21+
## Walkthrough
1522

16-
## Walkthroughs
1723
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.
1824

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

37-
# ... to add a Projector and a Consumer
43+
# ... to add a Projector
3844
md -p ../tools/My.Tools.Projector | Set-Location
3945
# (-k emits to Kafka and hence implies having a Consumer)
40-
dotnet new eqxprojector -k
46+
dotnet new proProjector -k
47+
start README.md
48+
49+
# ... to add a Consumer (proProjector -k emits to Kafka and hence implies having a Consumer)
50+
md -p ../../My.Consumer | Set-Location
51+
dotnet new proConsumer -k
4152
start README.md
4253

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

6172
## CONTRIBUTING

0 commit comments

Comments
 (0)