From b437683dd40b8d3324453197d22464990f1472d8 Mon Sep 17 00:00:00 2001 From: Richard Beauchamp Date: Thu, 5 Sep 2024 18:44:03 -0700 Subject: [PATCH] docs: update readme --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 9050457..d987589 100644 --- a/README.md +++ b/README.md @@ -34,10 +34,8 @@ Ready to dive in? [Get started](#getting-started) or [contribute](#contributing) ## Table of Contents - [Getting Started](#getting-started) -- [Features](#features) -- [Installation](#installation) -- [Quick Start Example](#quick-start-example) -- [RxDB Replication Protocol Implementation](#rxdb-replication-protocol-implementation) +- [Sample Implementation](#sample-implementation) +- [RxDB Replication Protocol Details](#rxdb-replication-protocol-details) - [Advanced Features](#advanced-features) - [Contributing](#contributing) - [Code of Conduct](#code-of-conduct) @@ -45,7 +43,7 @@ Ready to dive in? [Get started](#getting-started) or [contribute](#contributing) - [Acknowledgments](#acknowledgments) - [Contact](#contact) -## Installation +## Getting Started Here are the minimial steps to get you up and running with RxDBDotNet in your existing project: @@ -95,7 +93,7 @@ Here are the minimial steps to get you up and running with RxDBDotNet in your ex 4. Run your application and start using the GraphQL API for replication! -## Quick Start Example +## Sample Implementation Here's a more detailed example that demonstrates how to set up a simple document type and implement the required services to enable replication. @@ -376,7 +374,7 @@ app.Run(); These GraphQL operations demonstrate the core components of the RxDB replication protocol: push replication, pull replication with checkpoint management, and event observation through subscriptions. -## RxDB Replication Protocol Implementation +## RxDB Replication Protocol Details RxDBDotNet thoroughly implements the RxDB replication protocol with additional error handling conventions: