Skip to content

Commit

Permalink
Enhancement to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Stanislas POLU committed May 17, 2017
1 parent 5fd444a commit 7f44d99
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# README

```
_ ______ __________
| | /| / / __ `/ ___/ __ \
Expand All @@ -8,10 +10,14 @@

#### `warp` lets you securely share your terminal with one simple command

`warp` is designed for high-bandwidth interactions between developers. Once
connected to your warp clients will see your terminal exactly as if they were
sitting next to you. You can also grant them write access, the online
equivalent of handing them your keyboard.
`warp` is designed for high-bandwidth interactions between developers: when
connected to one of your warp clients see your terminal exactly as if they
were sitting next to you; granting them write access is also supported, the
virtual equivalent of handing them your keyboard.

`warp` distinguishes itself from "tmux/screen over ssh" by its focus and
simplicity to use as it does not require an SSH access to your machine or a
shared server for your clients to collaborate with you.

## Installation

Expand All @@ -33,9 +39,9 @@ Instantly start sharing your terminal (read-only) under warp ID **goofy-dev**
with:

```shell
# While **goofy-dev** is a pretty cool warp name, you can name your warps
# however you want. In particular a cryptographically secure random ID will be
# generated for you if you don't specifiy one.
# You can name your warps however you want (here **goofy-dev**). In particular
# a cryptographically secure random ID will be generated for you if you don't
# specifiy a name.

$ warp open goofy-dev
```
Expand Down Expand Up @@ -136,7 +142,8 @@ mitigate that, `warp` relies on automatic client terminal resizing.

Once connected as a client and whenever the host terminal window size changes,
`warp` will attempt to resize your terminal window to the hosting tty size. For
that reason it is recommended to run `warp connect` from a new terminal window.
that reason it is recommended to run `warp connect` from a new terminal
window[1].

#### Development of warp

Expand All @@ -147,3 +154,13 @@ connect at any time.

[0] You can run a warp from within tmux (or screen) or tmux from within a warp.
It's also fine to run a warp from within a warp.

[1] Window resize support:
| Terminal | Single Window | Tabs |
| --------------- |:-------------:|:-----:|
| MacOSX Terminal | Y | Y |
| iTerm2 | Y | N |
| Hyper | N | N |
| xterm | Y | N/A |


0 comments on commit 7f44d99

Please sign in to comment.