Skip to content

Commit 9e72998

Browse files
committed
docs: align overview introduction with readme
1 parent d77d34b commit 9e72998

1 file changed

Lines changed: 4 additions & 10 deletions

File tree

docs/content/docs/introduction/index.mdx

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,11 @@ icon: Rocket
66

77
## What is Comctx?
88

9-
Comctx is an RPC library for communication across different contexts in a JavaScript environment.
9+
Comctx aims to solve the communication problem between different contexts in a JavaScript environment.
1010

11-
Comctx has a similar goal to [Comlink](https://github.com/GoogleChromeLabs/comlink), but it is designed to adapt more flexibly to environments where [`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort) is not always the right fit.
11+
It has a similar goal to [Comlink](https://github.com/GoogleChromeLabs/comlink), but it is not trying to reinvent the wheel. Comlink relies on [`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort), which can be limited in some environments. See [Comlink issue #438](https://github.com/GoogleChromeLabs/comlink/issues/438) for one example.
12+
13+
Comctx is designed to adapt to different JavaScript environments, including Web Workers, browser extensions, iframes, Electron, and other message-based runtimes.
1214

1315
<video
1416
controls
@@ -28,14 +30,6 @@ Comctx has a similar goal to [Comlink](https://github.com/GoogleChromeLabs/comli
2830
Your browser does not support the video tag.
2931
</video>
3032

31-
It works across environments such as:
32-
33-
- Web Workers
34-
- Browser Extensions
35-
- iframes
36-
- Electron
37-
- other message-based JavaScript runtimes
38-
3933
## Features
4034

4135
- **Environment Agnostic** - Works across Web Workers, Browser Extensions, iframes, Electron, and more

0 commit comments

Comments
 (0)