Skip to content
This repository was archived by the owner on Aug 15, 2022. It is now read-only.

Commit 95a9990

Browse files
committed
v0.0.3
1 parent 439c3c8 commit 95a9990

File tree

2 files changed

+64
-12
lines changed

2 files changed

+64
-12
lines changed

README.md

Lines changed: 60 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,8 @@ _Recording looks ugly, but in terminal it seems to be fine_
1313
[![License](https://img.shields.io/npm/l/peerchat.svg)](https://github.com/dstack-js/chat/blob/master/package.json)
1414

1515
<!-- toc -->
16-
- [peerchat](#peerchat)
17-
- [Usage](#usage)
18-
- [Commands](#commands)
16+
* [Usage](#usage)
17+
* [Commands](#commands)
1918
<!-- tocstop -->
2019
# Usage
2120
<!-- usage -->
@@ -24,8 +23,24 @@ $ npm install -g peerchat
2423
$ peerchat COMMAND
2524
running command...
2625
$ peerchat (-v|--version|version)
27-
peerchat/0.0.1 darwin-x64 node-v16.13.1
26+
peerchat/0.0.3 darwin-x64 node-v16.13.1
2827
$ peerchat --help [COMMAND]
28+
USAGE
29+
$ peerchat COMMAND
30+
...
31+
```
32+
<!-- usagestop -->
33+
# Commands
34+
<!-- commands -->
35+
* [`peerchat [ROOM] [NICKNAME]`](#peerchat-room-nickname)
36+
* [`peerchat discord [ROOM]`](#peerchat-discord-room)
37+
* [`peerchat help [COMMAND]`](#peerchat-help-command)
38+
39+
## `peerchat [ROOM] [NICKNAME]`
40+
41+
Peer-to-peer terminal chat running on DStack
42+
43+
```
2944
USAGE
3045
$ peerchat [ROOM] [NICKNAME]
3146
@@ -38,12 +53,48 @@ OPTIONS
3853
3954
EXAMPLES
4055
$ peerchat
41-
$ peerchat ROOM NICKNAME
56+
$ peerchat [ROOM] [NICKNAME]
4257
$ peerchat dstack myCoolNickname
43-
...
4458
```
45-
<!-- usagestop -->
46-
# Commands
47-
<!-- commands -->
4859

60+
_See code: [src/commands/index.ts](https://github.com/dstack-js/chat/blob/v0.0.3/src/commands/index.ts)_
61+
62+
## `peerchat discord [ROOM]`
63+
64+
Peerchat <-> Discord
65+
66+
```
67+
USAGE
68+
$ peerchat discord [ROOM]
69+
70+
ARGUMENTS
71+
ROOM [default: dstack] chat room
72+
73+
OPTIONS
74+
-v, --version show CLI version
75+
76+
EXAMPLES
77+
$ peerchat discord
78+
$ peerchat discord [ROOM]
79+
$ peerchat discord dstack
80+
```
81+
82+
_See code: [src/commands/discord/index.ts](https://github.com/dstack-js/chat/blob/v0.0.3/src/commands/discord/index.ts)_
83+
84+
## `peerchat help [COMMAND]`
85+
86+
Display help for peerchat.
87+
88+
```
89+
USAGE
90+
$ peerchat help [COMMAND]
91+
92+
ARGUMENTS
93+
COMMAND Command to show help for.
94+
95+
OPTIONS
96+
-n, --nested-commands Include all nested commands in the output.
97+
```
98+
99+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.1.10/src/commands/help.ts)_
49100
<!-- commandsstop -->

package.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "peerchat",
33
"description": "Peer-to-peer terminal chat",
4-
"version": "0.0.1",
4+
"version": "0.0.3",
55
"author": "Mykhailo Marynenko @0x77dev",
66
"bin": {
77
"peerchat": "./bin/run",
@@ -27,14 +27,15 @@
2727
"eslint-config-oclif": "^3.1.2",
2828
"eslint-config-oclif-typescript": "^0.2.0",
2929
"ts-node": "^8",
30-
"typescript": "^3.3"
30+
"typescript": "^4.5.5"
3131
},
3232
"engines": {
3333
"node": ">=12.0.0"
3434
},
3535
"files": [
3636
"/bin",
37-
"/lib"
37+
"/lib",
38+
"README.md"
3839
],
3940
"homepage": "https://github.com/dstack-js/chat",
4041
"keywords": [

0 commit comments

Comments
 (0)