Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Usage: better docs #38

Open
pixelass opened this issue Dec 18, 2018 · 1 comment
Open

Usage: better docs #38

pixelass opened this issue Dec 18, 2018 · 1 comment

Comments

@pixelass
Copy link

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
Copy link
Owner

Sure, PR very welcome to add better docs examples!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants