vzcode 0.19.0 → 0.20.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +21 -0
- package/dist/assets/{index-34134182.js → index-c31dfdc2.js} +41 -38
- package/dist/index.html +1 -1
- package/package.json +11 -11
- package/src/client/App.tsx +12 -21
- package/src/client/CodeEditor/json1PresenceDisplay.js +26 -12
- package/src/client/CodeEditor/widgets.ts +95 -0
- package/src/client/Sidebar/ConfirmationBox.jsx +34 -0
- package/src/client/Sidebar/DirectoryListing.tsx +7 -1
- package/src/client/Sidebar/FileListing.tsx +13 -6
- package/src/client/Sidebar/Item.tsx +121 -0
- package/src/client/Sidebar/Listing.tsx +4 -1
- package/src/client/Sidebar/index.tsx +4 -1
- package/src/client/TabList/index.tsx +23 -1
- package/src/server/index.js +1 -1
- package/src/client/Sidebar/Item.jsx +0 -43
package/README.md
CHANGED
|
@@ -6,6 +6,7 @@ VZCode offers a multiplayer code editing environment that caters to a real-time
|
|
|
6
6
|
|
|
7
7
|
## Table of Contents
|
|
8
8
|
|
|
9
|
+
- [Usage](#usage)
|
|
9
10
|
- [Development](#development)
|
|
10
11
|
- [Features](#features)
|
|
11
12
|
- [Use Cases](#use-cases)
|
|
@@ -16,6 +17,26 @@ VZCode offers a multiplayer code editing environment that caters to a real-time
|
|
|
16
17
|
- [Team](#team)
|
|
17
18
|
- [Spaces](#spaces)
|
|
18
19
|
|
|
20
|
+
## Usage
|
|
21
|
+
|
|
22
|
+
You can use VZCode as an editor for your current directory if you install it globally with:
|
|
23
|
+
|
|
24
|
+
```
|
|
25
|
+
npm install -g vzcode
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
To open it, navigate to the directory of your choice in the terminal, then run
|
|
29
|
+
|
|
30
|
+
```
|
|
31
|
+
vzcode
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
A new browser window should automatically pop open with the files in that directory exposed for interactive multiplayer editing.
|
|
35
|
+
|
|
36
|
+
**Note:** A known shortcoming of VZCode is that it does not (yet) watch for changes from the file system. VZCode assumes that no other programs are modifying the same files. If another program does modify the same files at the same time, each VZCode auto-save will clobber the changes made by the other program.
|
|
37
|
+
|
|
38
|
+
To invite others to edit with you in real time, share your IP in your LAN with them to access. You can also expose your VZCode instance publicly using a tunneling service such as [NGrok](https://ngrok.com/). In fact, if you set your `NGROK_TOKEN` environment variable, VZCode will automatically connect and log the public URL when it starts.
|
|
39
|
+
|
|
19
40
|
## Development
|
|
20
41
|
|
|
21
42
|
- **Backlog & Issues**: Use our [Kanban Board](https://github.com/orgs/vizhub-core/projects/2/views/1) to track the backlog, [good first issues](https://github.com/orgs/vizhub-core/projects/2/views/1?filterQuery=label%3A%22good+first+issue%22), and [known bugs](https://github.com/orgs/vizhub-core/projects/2/views/1?filterQuery=label%3Abug).
|