Skip to content

Commit 7d89ea4

Browse files
authored
Update README
1 parent 81e6ec8 commit 7d89ea4

1 file changed

Lines changed: 21 additions & 11 deletions

File tree

README.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,31 @@
1-
# NoteSpace
2-
## BSc's Final Project
3-
### Instituto Superior de Engenharia de Lisboa
4-
#### Summer Semester 2023/2024
1+
<div align="center">
2+
3+
# Notespace
4+
5+
**Multi-platform Web Application for Real-Time Document Collaboration & Sharing**
6+
7+
[![tests](https://github.com/NoteSpaceTeam/NoteSpace/actions/workflows/main.yml/badge.svg)](https://github.com/NoteSpaceTeam/NoteSpace/actions/workflows/main.yml)
8+
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
9+
![GitHub repo size](https://img.shields.io/github/repo-size/NoteSpaceTeam/Notespace)
10+
11+
</div>
512

613
---
714

8-
**NoteSpace** is a collaborative web platform that combines real-time collaboration with version control systems. Users can collaborate on markdown-based documents in real time, organize them into workspaces and folders, track changes through commits, and share or fork public workspaces.
15+
**NoteSpace** is a web platform for collaborative editing of markdown documents within workspaces with a custom version control system.
916

1017
https://github.com/user-attachments/assets/69e5a22a-5f9b-4df7-9259-e08b17472e30
1118

1219
## Overview
1320

1421
### Real-Time Collaboration
15-
Edit the same document with multiple people at once. Changes sync instantly, even with concurrent edits, while keeping everyone in a consistent state, using the Fugue CRDT algorithm.
22+
Edit the same document with multiple people simultaneously, with changes syncing instantly even during concurrent edits, while keeping everyone in a consistent state using CRDTs.
1623

1724
### Workspace Management
18-
Organize notes and documents into workspaces and folders, with workspace-based access control for shared collaboration.
25+
Organize documents into workspaces and folders with a file-system structure and workspace-based access control.
1926

2027
### Markdown Support
21-
Write using markdown with live rendering. Supports standard formatting for fast, clean note-taking and technical documentation, such as headers, list items, and more.
28+
Write documents using Markdown with live rendering. Supports standard formatting for fast, clean note-taking and technical documentation, such as headers, list items, and more.
2229

2330
### Version Control
2431
Track changes, view past versions, and revert when needed using the built-in version control system.
@@ -33,11 +40,14 @@ Track changes, view past versions, and revert when needed using the built-in ver
3340
### Backend
3441
![](https://skillicons.dev/icons?i=typescript,nodejs,express,firebase,postgresql,docker)
3542

36-
## Developers
43+
## About
44+
### BSc's Final Project
45+
#### Instituto Superior de Engenharia de Lisboa (ISEL)
46+
##### Summer Semester, 2023/2024
3747

48+
**Developers:**
3849
- [Ricardo Costa](https://github.com/R1c4rdCo5t4)
3950
- [Guilherme Ferreira](https://github.com/GuilhermeF03)
4051

41-
## Supervisors
42-
52+
**Supervisors:**
4353
- [Paulo Pereira](https://github.com/palbp)

0 commit comments

Comments
 (0)