Sha256: c2af4599fe1a536255d338aa7275e9aaa515a4baf53be5fd8c44a844c2f49422

Contents?: true

Size: 1.06 KB

Versions: 2

Compression:

Stored size: 1.06 KB

Contents

# tldr-cli

This is a simple and tiny tldr-pages client write using Ruby that works well.


## Installation

    $ gem install tldr-cli

## Usage

    $ tldr [command]
    
Example:

    $ tldr tar

## Roadmap

- [x] basic cli interface
- [x] tldr-pages markdown content fetch
- [x] tldr-pages markdown parsing and presentation 
- [ ] implement content caching 
- [ ] content local cache update


## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/dvinciguerra/tldr-cli. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dvinciguerra/tldr-cli/blob/main/CODE_OF_CONDUCT.md).

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Tldr::Cli project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dvinciguerra/tldr-cli/blob/main/CODE_OF_CONDUCT.md).

Version data entries

2 entries across 2 versions & 1 rubygems

Version Path
tldr-cli-0.3.0 README.md
tldr-cli-0.2.0 README.md