search

marionebl / svg-term-cli

Share terminal sessions via SVG and CSS
MIT License
3.48k stars 116 forks source link

Usage: better docs #38

Open pixelass opened 5 years ago

pixelass commented 5 years ago

I don't fully understand how this would work and I think the project deserves a better documentation.

What is --cast? I'm not sure what to do with it (you mention an ID but no info around that. even a link to asciicast is missing). Only after reading into asciicast and understanding the upload option was I able to understand that this is not what I'm looking for.

svg-term --cast 113643

Suggestion

Maybe you can add better examples for common use cases. It will make this library easier to use. It might just be me but I think local recordings are more common since I see no need to upload this to any external service.

The following line would have saved me some time: 

svg-term --in my.cast --out my.svg

I know it's hidden in the options but that's not the focus of the readme.md (the Usage section is)

For people who easily get lost in bigger chunks of text it would help to at least add it here:

Examples
    $ cat rec.json | svg-term
    $ svg-term --cast 113643
    $ svg-term --cast 113643 --out examples/parrot.svg

I can create a PR for this if you want.

marionebl commented 5 years ago

Sure, PR very welcome to add better docs examples!