Skip to content

Commit 1281667

Browse files
committed
docs: update README
1 parent d93d214 commit 1281667

1 file changed

Lines changed: 10 additions & 12 deletions

File tree

README.md

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,29 @@
11
![P2P Live Share](https://raw.githubusercontent.com/kermanx/p2p-live-share/main/assets/internal/social-preview.png)
22

3-
[![Version](https://img.shields.io/github/v/release/kermanx/p2p-live-share)](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share) <!-- [![Installs](https://img.shields.io/visual-studio-marketplace/i/kermanx.p2p-live-share)](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share) --> [![Reactive VSCode](https://img.shields.io/badge/made_with-reactive--vscode-%23007ACC?style=flat&labelColor=%23229863)](https://kermanx.com/reactive-vscode/)
3+
[![Version](https://img.shields.io/github/v/release/kermanx/p2p-live-share)](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share) <!-- [![Installs](https://img.shields.io/visual-studio-marketplace/i/kermanx.p2p-live-share)](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share) --> [![reactive-vscode](https://img.shields.io/badge/made_with-reactive--vscode-%23007ACC?style=flat&labelColor=%23229863)](https://kermanx.com/reactive-vscode/)
44

5-
A peer-to-peer and open source alternative to [Live Share](https://visualstudio.microsoft.com/services/live-share/).
5+
A peer-to-peer and open-source alternative to [Live Share](https://visualstudio.microsoft.com/services/live-share/).
66

7-
This VSCode extension enables real-time collaborative editing, and...
7+
This VS Code extension enables real-time collaborative editing, and...
88

99
- Remote Language Service
1010
- Terminal Sharing
1111
- Port Forwarding
1212
- Chat with Images
13-
- Text Selection Sharing
13+
- Text Selection Sync
1414
- Workspace Files Sync
1515

16-
You can install this extension by searching "[**P2P Live Share**](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share)" in the [extension panel](https://code.visualstudio.com/docs/getstarted/extensions#_browse-extensions) of VSCode or Cursor.
17-
18-
To start sharing, click the "Share" button in the P2P Live Share panel, which you can find on the [Activity Bar](https://code.visualstudio.com/docs/getstarted/userinterface#_basic-layout).
16+
You can install this extension by searching "[**P2P Live Share**](https://marketplace.visualstudio.com/items?itemName=kermanx.p2p-live-share)" in the [extension panel](https://code.visualstudio.com/docs/getstarted/extensions#_browse-extensions) of VS Code. To start sharing, click the "Share" button in the P2P Live Share panel, which you can find on the [activity bar](https://code.visualstudio.com/docs/getstarted/userinterface#_basic-layout).
1917

2018
![Screenshot](https://raw.githubusercontent.com/kermanx/p2p-live-share/main/assets/internal/screenshot.png)
2119

2220
#### No Account Required
2321

2422
You won't need to sign in any account to use it. You can also improve its security and connectivity by [self-hosting a relay server](#self-hosted-relay-server). By default, it uses public signaling servers listed by [trystero](https://github.com/dmotz/trystero).
2523

26-
<!-- #### VSCode Web Support
24+
<!-- #### VS Code Web Support
2725
28-
This extension also works in [VSCode Web](https://vscode.dev/). You can join a session on your browser after installing the extension, and enjoy the same collaborative editing features, terminals and language service provided by the host. -->
26+
This extension also works in [VS Code Web](https://vscode.dev/). You can join a session on your browser after installing the extension, and enjoy the same collaborative editing features, terminals and language service provided by the host. -->
2927

3028
## Connectivity
3129

@@ -73,16 +71,16 @@ The host can directly listen for incoming WebSocket connections without a relay
7371
- WebSocket 支持:启用,空闲时间设置为 120 秒
7472
- 函数 URL 配置:开启公网访问
7573

76-
3. 部署完成后,进入“函数 URL”栏目,复制公网访问的 `wss://` 地址。在 VSCode 中点击 Share 后,填入该地址即可。
74+
3. 部署完成后,进入“函数 URL”栏目,复制公网访问的 `wss://` 地址。在 VS Code 中点击 Share 后,填入该地址即可。
7775

7876
</details>
7977

8078
## Disclaimer
8179

8280
This project is released under the MIT License. It is not affiliated with, endorsed by, or sponsored by Microsoft Corporation.
8381

84-
This project is not intended to replace Live Share, but to provide a free and open-source alternative for users who need it. As an official product, Live Share has access to [VSCode Proposed APIs](https://code.visualstudio.com/api/advanced-topics/using-proposed-api), which enable more advanced features such as sharing any opened terminals.
82+
This project is not intended to replace Live Share, but to provide a free and open-source alternative for users who need it. As an official product, Live Share has access to [VS Code Proposed APIs](https://code.visualstudio.com/api/advanced-topics/using-proposed-api), which enable more advanced features such as sharing any opened terminals.
8583

8684
This project is not stable yet. Please make sure to only share non-sensitive files. The author is not responsible for any data loss or leakage.
8785

88-
Part of the code under the `src/terminal/pty` folder is adapted from VSCode.
86+
Part of the code under the `src/terminal/pty` folder is adapted from VS Code.

0 commit comments

Comments
 (0)