Skip to content

Commit

Permalink
Started fleshing out Console Quickstart
Browse files Browse the repository at this point in the history
  • Loading branch information
einari committed Dec 27, 2024
1 parent 78d14b1 commit 205e5e0
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 2 deletions.
27 changes: 27 additions & 0 deletions Documentation/get-started/quickstart/console.md
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}}
2 changes: 2 additions & 0 deletions Documentation/get-started/quickstart/toc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
- name: Console
href: console.md
4 changes: 2 additions & 2 deletions Documentation/get-started/toc.yml
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

0 comments on commit 205e5e0

Please sign in to comment.