Skip to content

Commit

Permalink
docs: add vhs publish info to README (#342)
Browse files Browse the repository at this point in the history
* docs: add publish info to README

* fix(docs): grammar stuff

* docs: clean
  • Loading branch information
bashbunni authored Jul 20, 2023
1 parent 8da07a0 commit d42375a
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -154,12 +154,22 @@ settings or modify actions. Then, you can generate the GIF:
vhs cassette.tape
```

## Publish Tapes

VHS allows you to publish your GIFs to our servers for easy sharing with your
friends and colleagues. Specify which file you want to share, then use the
`publish` sub-command to host it on `vhs.charm.sh`. The output will provide you
with links to share your GIF via browser, HTML, and Markdown.

```bash
vhs publish demo.gif
```

## The VHS Server

VHS has an SSH server built in! When you self host VHS you can access it as
VHS has an SSH server built in! When you self-host VHS you can access it as
though it were installed locally. VHS will have access to commands and
applications on the host so you don't need to install them on your machine.
applications on the host, so you don't need to install them on your machine.

To start the server run:

Expand Down Expand Up @@ -221,7 +231,7 @@ Output frames/ # a directory of frames as a PNG sequence

The `Require` command allows you to specify dependencies for your tape file.
These are useful to fail early if a required program is missing from the
`$PATH` and it is certain that the VHS execution will not work as expected.
`$PATH`, and it is certain that the VHS execution will not work as expected.

Require commands must be defined at the top of a tape file, before any non-
setting or non-output command.
Expand Down

0 comments on commit d42375a

Please sign in to comment.