Skip to content

Commit d42375a

Browse files
authored
docs: add vhs publish info to README (#342)
* docs: add publish info to README * fix(docs): grammar stuff * docs: clean
1 parent 8da07a0 commit d42375a

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,22 @@ settings or modify actions. Then, you can generate the GIF:
154154
vhs cassette.tape
155155
```
156156

157+
## Publish Tapes
158+
159+
VHS allows you to publish your GIFs to our servers for easy sharing with your
160+
friends and colleagues. Specify which file you want to share, then use the
161+
`publish` sub-command to host it on `vhs.charm.sh`. The output will provide you
162+
with links to share your GIF via browser, HTML, and Markdown.
163+
164+
```bash
165+
vhs publish demo.gif
166+
```
157167

158168
## The VHS Server
159169

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

164174
To start the server run:
165175

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

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

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

0 commit comments

Comments
 (0)