Skip to content

Commit

Permalink
Merge pull request #65 from LSViana/improve-project-readme
Browse files Browse the repository at this point in the history
Include project logo and demo video in the README.md
  • Loading branch information
SebastianStehle authored Nov 25, 2023
2 parents bf303ec + 8a1952d commit 85f1e94
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img width="128" height="128" src="https://github.com/LSViana/ydotnet/assets/21217790/51be1008-7bac-4bb0-b5bb-d4c9f5ab6d7d" />
</p>

# YDotNet

YDotNet is a .NET binding for [`y-crdt`](https://github.com/y-crdt/ypy). It provides distributed data types that enable
Expand All @@ -6,6 +10,12 @@ real-time collaboration between devices. The library is a thin wrapper around Yr
> 💡 Disclaimer: this project is still early, so it may contain bugs and the API is subject to change. Feel free to
> [open an issue](https://github.com/LSViana/ydotnet/issues/new) if you'd like to report problems or suggest new features.
# Demo

Check the following video:

https://github.com/LSViana/ydotnet/assets/21217790/cdb6023d-25d1-4951-82ae-b079ddbd8d26

# Installation

> This section is a WIP, the project has not yet been published to [NuGet](https://www.nuget.org/).
Expand Down

0 comments on commit 85f1e94

Please sign in to comment.