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.

Sign up for GitHub

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

Jump to bottom

Improve documentation #67

Closed
Zingam opened this issue Sep 22, 2019 · 1 comment
Closed

Improve documentation #67

Zingam opened this issue Sep 22, 2019 · 1 comment

Comments

@Zingam
Copy link

Zingam commented Sep 22, 2019

The README is very long, dry and boring to read. I think we could use a chunked, HTML styled tutorial like docs with a TOC and hyperlinks too with some examples, so that relevant information could be searched easily.
It would be nice to see some statistics about what overhead could we expect when using the transcoding over native compression.
Also having some version number at the top of the README would be helpful to notify that a new milestone was released/something has changed.
@richgel999
Copy link
Contributor

I hear you. Better docs are coming!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Zingam @richgel999