chat-point 1.0.2 → 1.0.3
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 +104 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
# Chat Point CLI
|
|
2
|
+
|
|
3
|
+
A lightweight **command-line chatting tool** that allows developers to communicate directly from the terminal.
|
|
4
|
+
With Chat Point CLI, you can quickly create a chat room or join an existing one and start a real-time conversation without leaving your command line.
|
|
5
|
+
|
|
6
|
+
This tool is especially useful when:
|
|
7
|
+
|
|
8
|
+
* Working on projects with teammates in the terminal
|
|
9
|
+
* Running development sessions on remote machines
|
|
10
|
+
* Practicing networking or CLI-based workflows
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Features
|
|
15
|
+
|
|
16
|
+
* Real-time chat directly in the terminal
|
|
17
|
+
* Simple room creation and joining system
|
|
18
|
+
* Interactive CLI experience
|
|
19
|
+
* Lightweight and fast
|
|
20
|
+
* Works globally as a terminal command
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## Tech Stack
|
|
25
|
+
|
|
26
|
+
This project is built using:
|
|
27
|
+
|
|
28
|
+
* **Node.js** – Runtime for building the CLI tool
|
|
29
|
+
* **WebSockets (ws)** – Real-time communication between users
|
|
30
|
+
* **Inquirer** – Interactive command-line prompts
|
|
31
|
+
* **npm CLI packaging** – For global installation and distribution
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## Installation
|
|
36
|
+
|
|
37
|
+
Install the package globally using npm:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm install -g chat-point
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
This will install the CLI tool globally and make the `chat` command available in your terminal.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## How to Run
|
|
48
|
+
|
|
49
|
+
Start the CLI tool by running:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
chat
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## How It Works
|
|
58
|
+
|
|
59
|
+
1. One user **creates a room**.
|
|
60
|
+
2. Other users **join the room**.
|
|
61
|
+
3. Everyone in the room can start chatting in real time.
|
|
62
|
+
|
|
63
|
+
Typical flow:
|
|
64
|
+
|
|
65
|
+
```text
|
|
66
|
+
User 1 → Create Room
|
|
67
|
+
User 2 → Join Room
|
|
68
|
+
Both → Start chatting
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## Example Usage
|
|
74
|
+
|
|
75
|
+
```bash
|
|
76
|
+
chat
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Then follow the interactive prompts to:
|
|
80
|
+
|
|
81
|
+
* Create a new chat room
|
|
82
|
+
* Join an existing chat room
|
|
83
|
+
* Start chatting instantly
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Use Cases
|
|
88
|
+
|
|
89
|
+
* Developers collaborating from the terminal
|
|
90
|
+
* Remote team communication
|
|
91
|
+
* Learning CLI and WebSocket-based applications
|
|
92
|
+
* Lightweight chat without GUI apps
|
|
93
|
+
|
|
94
|
+
---
|
|
95
|
+
|
|
96
|
+
## Author
|
|
97
|
+
|
|
98
|
+
**Sahil Singh**
|
|
99
|
+
|
|
100
|
+
---
|
|
101
|
+
|
|
102
|
+
## License
|
|
103
|
+
|
|
104
|
+
ISC License
|