Skip to content

Commit 523a018

Browse files
Update README.md (#893)
1 parent 7a463f5 commit 523a018

1 file changed

Lines changed: 32 additions & 38 deletions

File tree

docs/getting-started/quickstart/README.md

Lines changed: 32 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ If you have trouble with this quickstart, you can find more help in the ["Kurren
6060

6161
:::
6262

63-
2. Login to GitHub if required.
63+
2. Log in to GitHub if required.
6464

6565
3. Follow the instructions to create a new Codespace.
6666

@@ -73,7 +73,7 @@ Hello!👋 Welcome to the KurrentDB Getting Started Quickstart Guide.
7373
```
7474

7575
::: tip
76-
For this quickstart, you can safely ignore and close any Codespaces notification that appears on the bottom right of the page.
76+
For this quickstart, you can safely ignore and close any Codespaces notifications that appear on the bottom right of the page.
7777
:::
7878

7979
## Step 2: Start the KurrentDB Server
@@ -86,7 +86,7 @@ For this quickstart, you can safely ignore and close any Codespaces notification
8686

8787
This is a custom script written for this quickstart to help start KurrentDB in Docker.
8888

89-
2. You will see the below message printed in the terminal:
89+
2. You will see the following message printed in the terminal:
9090

9191
```
9292
🚀 KurrentDB Server has started!! 🚀
@@ -138,39 +138,39 @@ For more information about other KurrentDB parameters and settings, [click here]
138138
:::
139139

140140
:::: info
141-
To view the source code in Github, click the link below:
141+
To view the source code on Github, click the link below:
142142

143143
::: tabs#dev-language-platform
144144
@tab Select >
145145

146146
@tab Python
147-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Python)
147+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDB-From-Scratch-Python)
148148

149149
@tab Java
150-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Java)
150+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Java)
151151

152152
@tab .NET
153-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Dotnet)
153+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Dotnet)
154154

155155
@tab node.js
156-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Nodejs)
156+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Nodejs)
157157
:::
158158
::::
159159
:::::
160160

161161
## Step 3: Navigate to the KurrentDB Admin UI
162162

163-
1. In Codespaces, copy the URL to KurrentDB Admin UI printed in the terminal from last step.
163+
1. In Codespaces, copy the URL to KurrentDB Admin UI printed in the terminal from the last step.
164164
2. Open a new browser tab.
165-
3. In the address bar of the new tab, paste the URL to and navigate to it.
165+
3. In the address bar of the new tab, paste the URL and navigate to it.
166166
4. This will display the KurrentDB Admin UI.
167167
5. Keep the Admin UI open for the next steps.
168168

169169
![KurrentDB Admin UI Dashboard](images/hello-world/admin-ui.png =300x)
170170

171171
## Step 4: Install Required Package for Sample Code
172172

173-
1. In Codespace, run this command to install the package for the KurrentDB client. This will be used in the sample codes:
173+
1. In Codespace, run the following command to install the KurrentDB client package. This will be used in the sample codes:
174174

175175
::: tabs#dev-language-platform
176176
@tab Select >
@@ -276,24 +276,22 @@ The version of the KurrentDB client above may be outdated. For more information
276276
:::
277277

278278
:::: info
279-
To view the source code in GitHub, click the link below:
279+
To view the source code on GitHub, click the link below:
280280

281281
::: tabs#dev-language-platform
282282
@tab Select >
283283

284284
@tab Python
285-
286-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Python)
287-
285+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDB-From-Scratch-Python)
288286

289287
@tab Java
290-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Java)
288+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Java)
291289

292290
@tab .NET
293-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Dotnet)
291+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Dotnet)
294292

295293
@tab node.js
296-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Nodejs)
294+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Nodejs)
297295
:::
298296

299297
::::
@@ -345,7 +343,7 @@ Event Body: {"id":"1","importantData":"some value"}
345343

346344
#### Understanding How the Append Sample Works
347345

348-
To deepen your understanding of how events are appended to KurrentDB programmatically, you will explore the sample code used in this step.
346+
To help you understand how events are appended to KurrentDB programmatically, you will explore the sample code used in this step.
349347

350348
The sample code demonstrates:
351349

@@ -355,7 +353,7 @@ The sample code demonstrates:
355353

356354
To see how this works, follow these steps:
357355

358-
1. Run the following command to open sample code:
356+
1. Run the following command to open the sample code:
359357

360358
::: tabs#dev-language-platform
361359
@tab Select >
@@ -516,24 +514,22 @@ To learn more about other KurrentDB client functions, [click here](@clients/grpc
516514
:::
517515

518516
:::: info
519-
To view the source code in GitHub, click the link below:
517+
To view the source code on GitHub, click the link below:
520518

521519
::: tabs#dev-language-platform
522520
@tab Select >
523521

524522
@tab Python
525-
526-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Python)
527-
523+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDB-From-Scratch-Python)
528524

529525
@tab Java
530-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Java)
526+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Java)
531527

532528
@tab .NET
533-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Dotnet)
529+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Dotnet)
534530

535531
@tab node.js
536-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Nodejs)
532+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Nodejs)
537533
:::
538534

539535
::::
@@ -544,7 +540,7 @@ To view the source code in GitHub, click the link below:
544540

545541
1. In the Admin UI, click the `Stream Browser` link from the top navigation bar.
546542

547-
2. Under `Recently Changed Streams`, click `SampleStream` link.
543+
2. Under `Recently Changed Streams`, click the `SampleStream` link.
548544

549545
3. Click on the `JSON` link in the rightmost column of the table.
550546

@@ -595,15 +591,15 @@ Event Body: {"id":"1","importantData":"some value"}
595591

596592
#### Understanding How the Read Sample Works
597593

598-
You will explore the sample code used in this step to further understand how events are read from KurrentDB programmatically.
594+
You will explore the sample code used in this step to gain a deeper understanding of how events are read from KurrentDB programmatically.
599595
The sample code demonstrates the following:
600596
- **Establishing a Connection**: Illustrates how to connect to KurrentDB using the client library.
601597
- **Reading Events from a Stream**: Reads events from a specific stream.
602598
- **Processing Retrieved Events**: Iterates over the events retrieved from the stream.
603599
- **Deserializing Event Data**: Extracts and deserializes the event data from the retrieved events.
604600
- **Displaying Event Information**: Prints out the event details—such as the stream name, event type, and event body—to the console.
605601

606-
1. Run the following command to open sample code:
602+
1. Run the following command to open the sample code:
607603

608604
::: tabs#dev-language-platform
609605
@tab Select >
@@ -781,24 +777,22 @@ To learn more about other KurrentDB client functions, [click here](@clients/grpc
781777
:::
782778
783779
:::: info
784-
To view the source code in Github, click the link below:
780+
To view the source code on Github, click the link below:
785781
786782
::: tabs#dev-language-platform
787783
@tab Select >
788784
789785
@tab Python
790-
791-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Python)
792-
786+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Python-blue?logo=github)](https://github.com/kurrent-io/KurrentDB-From-Scratch-Python)
793787
794788
@tab Java
795-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Java)
789+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Java-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Java)
796790
797791
@tab .NET
798-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Dotnet)
792+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20.NET-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Dotnet)
799793
800794
@tab node.js
801-
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/KurrentDBDB-From-Scratch-Nodejs)
795+
[![](https://img.shields.io/badge/GitHub-EventStoreDB%20From%20Scratch%20Node.js-blue?logo=github)](https://github.com/kurrent-io/EventStoreDB-From-Scratch-Nodejs)
802796
:::
803797
804798
::::
@@ -815,7 +809,7 @@ In this quickstart, you:
815809
4. Verified the event in the Admin UI.
816810
5. Read the event from KurrentDB programmatically.
817811
818-
Feel free to experiment further by appending more events, reading them, or even exploring advanced features of KurrentDB!
812+
Feel free to experiment further by appending more events, reading them, or exploring the advanced features of KurrentDB.
819813
820814
## Next Steps
821815

0 commit comments

Comments
 (0)