Skip to content

Commit 1a1b958

Browse files
committed
update readme and changelog
1 parent fd6f8ed commit 1a1b958

File tree

2 files changed

+10
-5
lines changed

2 files changed

+10
-5
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## 0.2.0.0
2-
* Add ability to copy+paste using keystrokes
2+
* Add ability to copy+paste using keystrokes (copy with ctrl+shift+c or ctrl+shift+x, and paste with ctrl+shift+v)
33
* Add a status bar to the bottom of the page
44
* Show terminal dimensions in bottom status bar
55
* Add toasts to notify user of various events

README.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ TermPair lets developers securely share and control terminals in real time.
2727

2828
## Usage
2929

30-
Start the TermPair server with `termpair serve`, or use the one already running at [https://chadsmith.dev/termpair](https://chadsmith.dev/termpair).
30+
First start the TermPair server with `termpair serve`, or use the one already running at [https://chadsmith.dev/termpair](https://chadsmith.dev/termpair).
31+
32+
The server is used to route encrypted data between terminals and connected browsers.
3133

3234
```
3335
> termpair serve --port 8000
@@ -38,7 +40,9 @@ INFO: Uvicorn running on http://localhost:8000 (Press CTRL+C to quit)
3840
INFO: ('127.0.0.1', 51924) - "WebSocket /connect_to_terminal" [accepted]
3941
```
4042

41-
Then share your terminal by running `termpair share`:
43+
Then share your terminal by running `termpair share`.
44+
45+
This connects your terminal to the server, and allows browsers to access the terminal.
4246

4347
```
4448
> termpair share --port 8000
@@ -52,7 +56,7 @@ Type 'exit' or close terminal to stop sharing.
5256
--------------------------------------------------------------------------------
5357
```
5458

55-
You can share that URL with whoever you want. Note that anyone that has it can view and possibly control your terminal.
59+
The URL printed contains a unique terminal ID and an encryption key. You can share that URL with whoever you want. Anyone who has it can access your terminal while the `termpair share` process is running.
5660

5761
The server multicasts terminal output to all browsers that connect to the session.
5862

@@ -117,10 +121,11 @@ or install with [pip](https://pip.pypa.io/en/stable/)
117121
## Serving with NGINX
118122
Running behind an nginx proxy can be done with the following configuration.
119123

120-
TermPair must be started with `termpair serve`, and the port being run on must be specified in the `upstream` configuration.
124+
The TermPair server must be started with `termpair serve`, and the port being run on must be specified in the `upstream` configuration.
121125

122126
```nginx
123127
upstream termpair_app {
128+
# Make sure the port matches the port you are running on
124129
server 127.0.0.1:8000;
125130
}
126131

0 commit comments

Comments
 (0)