tldr-node-client

Patches

• Fixed the issue of cache not being populated after first install.

Documentation

• Updated README text on themes

Features

• Upgraded entire codebase to ES6. And so bumped up minimum node version to 4.7
• Added option (-m/--markdown) to render a page in raw markdown format

Patches

• Fixed a lint error in config.js
• Fixed a backtick parsing issue.

Features

• Fixed the issue in installation where the updating was happening in the postinstall step. Now, the cache is updated whenever a page is not found.

Features

• Added complete theme support, with new themes. Removed colors from config as it wasn't used anymore
• Fix gobbling up of bold and italic text

Documentation

• Changed the installation step with sudo to use --user parameter. This fixes the permission error that comes when installing with sudo.

Patches

• Upgraded libraries to their latest versions
• Updated the screenshot
• Simplified package.json
• Moved from wrench to fs-extra since the former was deprecated.

Features

• Added metadata to build a Snap package for tldr.

Features

• Support commands with spaces, e.g. tldr git commit (#80).
• Build indexes on update: shortIndex.json and index.json (#70, #78)
• Rewrite --list and --list-all with indexes (#83)

Libraries

• Stop using packages: cpr, async, strings, mkdirp; use wrench instead
• Upgrade some libraries to the recent versions: request, mocha, should
• Switch to modularized LoDash (808b880)
• Switch to the using latest versions (*) for the devDependencies
• Upgrade to ESLint 2.0

Infrastructure

• Functional test in the form of a Bash script which runs the main commands (#72)
• Windows AppVeyor CI integration (#79, #85)
• A lot more ESLint rules, big refactoring related to it (#84)

Documentation

• Mention the platform options (--linux, --sunos, --osx) in README.md (#76)

• Fix --list and --list-options commands on Windows

• --list (-l) option now shows the list of commands on current platform in cache
• --list-all (-a) option shows the list of all commands in cache
• --single-column (-1) option is used together with --list or --list-all to show list of commands as a single column, similarly to ls -1
• Added platform shortcuts --linux, --osx, --sunos, they can be used instead of --os=linux
• better test coverage
• functional test of all major CLI options is added, it is integrated with Travis CI

• Auto-update on installation (kudos @shybovycha)
• Performance improvement - 30-40% (kudos @amitzur and @VarunAgw for escalation and investigation)
• Adding documentation for --os option in README.md and on --help
• Print more useful information (help) when no options passed (thanks @qw3rtman for idea)

• Windows support (kudos to @Mopolo as well as others who insisted on this feature)
• linting with ESLint before commit
• better badges in README.md
• more keywords in package.json

• Update dependencies

Features:

• Choose the platform

You can choose the platform by --os CLI option or "platform" in ~/.tldrrc.

Check the following examples:

tldr du --os=osx
tldr du --os=linux

• Libraries upgrade
• Linting with ESLint
• Minor refactoring and fixes

Fixes:

• Fix "Page not found" message

Features:

• tldr --update fetches pages archive from http://tldr-pages.github.io/assets/tldr.zip

Fixes:

• Characters < (less) and > (more) are now correctly rendered (#25)
• Correctly show backticks characters in command description and example description (#17)
• Fix subcommands (#15)

Improvements:

• Migrated to new Travis architecture