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

Docs: Add better usage instructions to docs #218

Open
dbrgn opened this issue Oct 17, 2021 · 2 comments
Open

Docs: Add better usage instructions to docs #218

dbrgn opened this issue Oct 17, 2021 · 2 comments

Comments

@dbrgn
Copy link
Collaborator

dbrgn commented Oct 17, 2021

In #108 the argument parsing was switched from docopt to clap. This resulted in the removal of the examples:

Examples:

    $ tldr tar
    $ tldr --list

To control the cache:

    $ tldr --update
    $ tldr --clear-cache

To render a local file (for testing):

    $ tldr --render /path/to/file.md

The usage docs should probably be updated to include some examples like this. In general, we should explain to the user how tealdeer can be used. (This can be done through examples, but other means are possible as well.)

@bound-variable

This comment has been minimized.

@dbrgn

This comment has been minimized.

@dbrgn dbrgn mentioned this issue Dec 20, 2021
dbrgn added a commit that referenced this issue Dec 24, 2021
@dbrgn dbrgn added this to the v1.5.1 milestone Jan 1, 2022
@dbrgn dbrgn modified the milestones: v1.5.1, v1.6.0 Sep 28, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants