Mirrors/asciinema
1
0
Fork 0
mirror of https://github.com/asciinema/asciinema.git synced 2025-12-16 19:58:03 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add streaming examples to the README

Browse Source
This commit is contained in:
Marcin Kulik
2024-05-07 11:18:53 +02:00
parent 3d6e76f80c
commit 6a9bd66036
1 changed files with 13 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@@ -35,12 +35,24 @@ Notable features:
server](https://docs.asciinema.org/manual/server/), e.g. server](https://docs.asciinema.org/manual/server/), e.g.
[asciinema.org](https://asciinema.org), for easy recording hosting. [asciinema.org](https://asciinema.org), for easy recording hosting.
Recording is as easy as running this command in your shell: To record a session run this command in your shell:
```sh ```sh
asciinema rec demo.cast asciinema rec demo.cast
``` ```
To stream a session via built-in HTTP server run:
```sh
asciinema stream --serve
```
To stream a session via a relay (asciinema server) run:
```sh
asciinema stream --relay
```
Check out the [Getting started Check out the [Getting started
guide](https://docs.asciinema.org/getting-started/) for installation and usage guide](https://docs.asciinema.org/getting-started/) for installation and usage
overview. overview.