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

Commit 5db2b42

Browse files
committed
chore(docs): add demo and usage
1 parent 2f22059 commit 5db2b42

File tree

2 files changed

+174
-3
lines changed

2 files changed

+174
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,19 @@ peerchat
33

44
Peer-to-peer terminal chat based on [DStack](https://github.com/dstack-js/dstack)
55

6+
![Demo](docs/demo.svg)
7+
8+
_Recording looks ugly, but in terminal it seems to be fine_
9+
610
[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
711
[![Version](https://img.shields.io/npm/v/peerchat.svg)](https://npmjs.org/package/peerchat)
812
[![Downloads/week](https://img.shields.io/npm/dw/peerchat.svg)](https://npmjs.org/package/peerchat)
913
[![License](https://img.shields.io/npm/l/peerchat.svg)](https://github.com/dstack-js/chat/blob/master/package.json)
1014

1115
<!-- toc -->
12-
* [Usage](#usage)
13-
* [Commands](#commands)
16+
- [peerchat](#peerchat)
17+
- [Usage](#usage)
18+
- [Commands](#commands)
1419
<!-- tocstop -->
1520
# Usage
1621
<!-- usage -->
@@ -22,7 +27,19 @@ $ peerchat (-v|--version|version)
2227
peerchat/0.0.1 darwin-x64 node-v16.13.1
2328
$ peerchat --help [COMMAND]
2429
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
2643
...
2744
```
2845
<!-- usagestop -->

docs/demo.svg

Lines changed: 154 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)