-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Started fleshing out Console Quickstart
- Loading branch information
Showing
3 changed files
with
31 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Quickstart Console | ||
|
||
## Client | ||
|
||
Chronicle is accessed through its client called `ChronicleClient`. | ||
From this instance you can get the event store you want to work with. | ||
|
||
The simplest thing you can do is to rely on the automatic discovery of artifacts by telling | ||
the event store to discover and register everything automatically. | ||
|
||
The following snippet configures the minimum and discovers everything for you. | ||
|
||
{{snippet:Quickstart-Setup}} | ||
|
||
## Events | ||
|
||
Defining an event is very simple. You can either use a C# `class` or a `record` type. | ||
We recommend using a `record` type, since records are immutable, much like an [event](../../concepts/event.md) | ||
should be. | ||
|
||
With the type defined you simply add the `[EventType]` attribute for the new type. | ||
The reason you do this is for the discovery system to be able to pick up all the event types | ||
automatically. | ||
|
||
Below defines a set of events we want to use for our library sample. | ||
|
||
{{snippet:Quickstart-Events}} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
- name: Console | ||
href: console.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
- name: Introduction | ||
href: index.md | ||
- name: Quickstart | ||
href: quickstart/toc.yml | ||
- name: Basic | ||
href: basic.md |