This repository was archived by the owner on Aug 15, 2022. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +174
-3
lines changed Expand file tree Collapse file tree 2 files changed +174
-3
lines changed Original file line number Diff line number Diff line change @@ -3,14 +3,19 @@ peerchat
3
3
4
4
Peer-to-peer terminal chat based on [ DStack] ( https://github.com/dstack-js/dstack )
5
5
6
+ ![ Demo] ( docs/demo.svg )
7
+
8
+ _ Recording looks ugly, but in terminal it seems to be fine_
9
+
6
10
[ ![ oclif] ( https://img.shields.io/badge/cli-oclif-brightgreen.svg )] ( https://oclif.io )
7
11
[ ![ Version] ( https://img.shields.io/npm/v/peerchat.svg )] ( https://npmjs.org/package/peerchat )
8
12
[ ![ Downloads/week] ( https://img.shields.io/npm/dw/peerchat.svg )] ( https://npmjs.org/package/peerchat )
9
13
[ ![ License] ( https://img.shields.io/npm/l/peerchat.svg )] ( https://github.com/dstack-js/chat/blob/master/package.json )
10
14
11
15
<!-- toc -->
12
- * [ Usage] ( #usage )
13
- * [ Commands] ( #commands )
16
+ - [ peerchat] ( #peerchat )
17
+ - [ Usage] ( #usage )
18
+ - [ Commands] ( #commands )
14
19
<!-- tocstop -->
15
20
# Usage
16
21
<!-- usage -->
@@ -22,7 +27,19 @@ $ peerchat (-v|--version|version)
22
27
peerchat/0.0.1 darwin-x64 node-v16.13.1
23
28
$ peerchat --help [COMMAND]
24
29
USAGE
25
- $ peerchat COMMAND
30
+ $ peerchat [ROOM] [NICKNAME]
31
+
32
+ ARGUMENTS
33
+ ROOM [default: dstack] chat room
34
+ NICKNAME your nickname
35
+
36
+ OPTIONS
37
+ -v, --version show CLI version
38
+
39
+ EXAMPLES
40
+ $ peerchat
41
+ $ peerchat ROOM NICKNAME
42
+ $ peerchat dstack myCoolNickname
26
43
...
27
44
```
28
45
<!-- usagestop -->
You can’t perform that action at this time.
0 commit comments