Skip to content

Commit

Permalink
Update README and landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
ekzhang committed Sep 10, 2023
1 parent bd73f7e commit a18ce56
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 19 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,31 @@ curl -sSf https://sshx.io/get | sh
Supports Linux and MacOS, on both x86_64 and arm64 architectures. The
precompiled Linux binaries are statically linked.

### CI/CD

You can also use sshx in continuous integration workflows to help debug tricky
issues, like in GitHub Actions.

```yaml
name: CI
on: push

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3

# ... other steps ...

- run: curl -sSf https://sshx.io/get | sh && sshx
# ^ This will open a remote terminal session and print the URL. It should
# take under a second.
```

We don't have a prepackaged action because it's just a single command. It works
anywhere: GitLab CI, CircleCI, CI on your Raspberry Pi, etc.

## Development

Here's how to work on the project, if you want to contribute.
Expand Down
40 changes: 21 additions & 19 deletions src/routes/+page.svelte
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,18 @@
</script>

<div class="overflow-x-hidden absolute inset-0">
<div class="w-full bg-pink-700 text-white text-xl px-4 py-8 text-center">
<strong>Warning:</strong> sshx is not ready or publicly released yet. Use at
your own risk.
</div>

<main class="max-w-screen-xl mx-auto px-4 md:px-8 lg:px-16">
<header class="my-12">
<img class="h-16 -mx-1" src={logotypeDark} alt="sshx logo" />
</header>
<h1>
Web-based, <span class="title-gradient">real-time collaboration</span> for
your remote terminal
A secure web-based,
<span class="title-gradient">collaborative</span> terminal.
</h1>

<div class="relative">
Expand All @@ -67,17 +72,17 @@

<section class="my-12 space-y-6 text-lg md:max-w-[460px] text-gray-400">
<p>
<code>sshx</code> gives you a link to share terminals with anyone, on a multiplayer
infinite canvas.
<code>sshx</code> gives you a link to share your terminal with anyone,
on a <b>multiplayer infinite canvas</b>.
</p>
<p>
It has <b>live cursors</b> and <b>chat</b> so you can work with whoever
is online. Also, <b>it's fast</b>, with a simple CLI tool and server
written in Rust.
It has <b>real-time collaboration</b>, with remote cursors and chat.
Also, it's <b>fast</b> and <b>end-to-end encrypted</b>, with client and
server binaries written in Rust.
</p>
<p>
Use <code>sshx</code> for pair programming, demos, remote access, or even
as a fashionable web interface for your computer.
Install <code>sshx</code> with just one command. Use it for teaching, debugging,
or cloud access.
</p>
</section>

Expand All @@ -102,8 +107,8 @@
<span class="pill mr-3">1</span> Install the CLI
</h3>
<p class="text-gray-400">
Download the <code>sshx</code> binary to get started. It's tiny, only a
few megabytes, and you have multiple installation options.
Get the <code>sshx</code> binary by running the following in your terminal.
It's tiny and downloads in seconds (3 MB).
</p>
<div class="flex flex-col items-start text-base">
<div class="flex rounded-t text-sm bg-gray-900">
Expand All @@ -125,25 +130,22 @@
target="_blank"
rel="noreferrer"
class="underline underline-offset-2 text-gray-300"
href="https://github.com/ekzhang/sshx">from the repository</a
>.
href="https://github.com/ekzhang/sshx">from source</a
>, if you'd like.
</p>
</div>
<div class="space-y-6">
<h3 class="step-heading">
<span class="pill mr-3">2</span> Share your terminal
</h3>

<p class="text-gray-400">
Run a single command in your favorite shell.
</p>
<p class="text-gray-400">Run this command in your favorite terminal.</p>

<pre class="rounded">sshx</pre>

<p class="text-gray-400">
This kicks off a live session and assigns a unique link at <code
>https://sshx.io/s/$ID</code
>. Invite anyone to join.
This kicks off a live, encrypted session with a unique link. Open the
link in a web browser to join.
</p>
</div>
</div>
Expand Down

0 comments on commit a18ce56

Please sign in to comment.