Skip to content

Commit 5124c61

Browse files
committed
updated README
1 parent 37cbccf commit 5124c61

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
# 📝 CollabPad
22

3-
> Google-Docs-style real-time Markdown editor built from scratch with CRDTs & full-stack TypeScript.
3+
Google-Docs-style real-time Markdown editor built from scratch with CRDTs & full-stack TypeScript.
44

55
[![CI](https://github.com/ferecci/collabpad/actions/workflows/ci.yml/badge.svg)](https://github.com/ferecci/collabpad/actions/workflows/ci.yml)
66
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
7-
[![Coverage](https://img.shields.io/badge/coverage-vitest-brightgreen)](#-testing)
87

98
<div align="center">
109
<img src="docs/demo.gif" width="800" alt="CollabPad live demo" />
1110
</div>
1211

1312
---
1413

14+
CollabPad is a modern, real-time collaborative Markdown editor that enables multiple users to edit documents simultaneously with conflict-free merging. Built with technologies like Yjs CRDTs and WebSockets, it provides a seamless Google Docs-like experience for Markdown editing with features like multi-cursor presence, offline support, and instant synchronization.
15+
1516
## Features
1617

1718
| Category | |

src/components/CreateDocumentModal.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ export function CreateDocumentModal({
4040
});
4141
};
4242

43+
// Clear error when modal is closed
4344
React.useEffect(() => {
4445
if (!isOpen) setMutationError(null);
4546
}, [isOpen]);

0 commit comments

Comments
 (0)