Skip to content

Commit

Permalink
Update project files
Browse files Browse the repository at this point in the history
  • Loading branch information
lirsacc committed Nov 27, 2023
1 parent 19c981d commit 5834c78
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
## Why?

I've recently found myself in multiple meetings editing diagram with multiple people as we work through a problem and felt the need for this. It's also a good opportunity to play with WebRTC and CRDTs.
I've recently found myself in multiple meetings editing diagram with multiple people as we work through a problem and felt the need for this as the [Mermaid Live Editor](https://mermaid.live/edit) doesn't support this. It's also a good opportunity to play with WebRTC and CRDTs.

Other options:

- There are multiple code based editor online but they don't support multiplayer so we're stuck watching one person write things down.
E.g. [Mermaid's live editor](https://mermaid.live/edit#pako:eNpt0LFuAjEMBuBXMZ7DC9xAhcRQKnXqVmWxkv-4SElMQyKEEO9O7q5seLKc749k39mpBw98wV9DdjgEORVJNlOvfQwO293uS6c80CdiVJp7Q5NeSQropu3jnV2VkzwLmiCFEv7l_Lbtckn0b8OaNXRcAgvuqc1bfaQRiHQqkLphwwklSfB9g_vsLdcJCZaH3nqM0mK1bPOjU2lVf27Z8VBLg-F29lJfC7-G8KFq-V6PstzG8Fnyr2ono8QLHk-kw2Qy).
- We could use a VSCode remote session but that only works if everyone has it setup and the firewall plays nice.
- Many visual editors have multiplayer but I'd prefer editing in a text format for easy sharing, version tracking and inclusion in other tech docs later.
- We can also use a collaborative Markdown editor with mermaid support, e.g. [HackMD](https://hackmd.io/). This is honestly pretty close to what I want with very few rough edges.

## Architecture

Expand Down
4 changes: 4 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
{
"name": "siren-chorus",
"private": true,
"license": "MIT",
"version": "0.0.1",
"scripts": {
"build": "parcel build src/index.html",
"dev": "parcel --no-autoinstall src/index.html",
Expand Down

0 comments on commit 5834c78

Please sign in to comment.