Skip to content

Commit

Permalink
docs: update readme (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
rbeauchamp authored Sep 6, 2024
1 parent 824fe00 commit 7768b2e
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,18 +34,16 @@ 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)
- [License](#license)
- [Acknowledgments](#acknowledgments)
- [Contact](#contact)

## Installation
## Getting Started

Here are the minimial steps to get you up and running with RxDBDotNet in your existing project:

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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:
Expand Down

0 comments on commit 7768b2e

Please sign in to comment.