Merge pull request #765 from tldr-pages/tldr-readme

Add tldr for installing or trying right on top.

README.md

@@ -7,12 +7,9 @@
 [gitter-url]: https://gitter.im/tldr-pages/tldr
 [gitter-image]: https://img.shields.io/gitter/room/tldr-pages/tldr.svg
 
-*tldr* is a collection of simplified and community-driven man pages.
+A collection of simplified and community-driven man pages.
 
-## What does tldr mean?
+Install it with `npm install -g tldr` or [try the web client](https://ostera.github.io/tldr.jsx).
-TL;DR stands for "Too Long; Didn't Read".
-It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy.
-Read more in the [TLDR article on Wikipedia](https://en.wikipedia.org/wiki/TL;DR).
 
 ## What is tldr?
 
@@ -40,37 +37,34 @@ for the most common UNIX / Linux / OSX / SunOS commands.
 
 You can access these pages on your computer using one of the following clients:
 
-- [Node.js client](https://github.com/tldr-pages/tldr-node-client) : `npm install -g tldr`
-- Python clients:
-  - [tldr-python-client](https://github.com/tldr-pages/tldr-python-client) : `pip install tldr`
-  - [tldr.py](https://github.com/lord63/tldr.py): `pip install tldr.py`
-- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr`
-  (or [platform binaries](https://github.com/pranavraja/tldr/releases))
-- [Elixir client](https://github.com/tldr-pages/tldr_elixir_client) (binaries not yet available)
-- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew install tldr-pages/tldr/tldr`
 - Android clients:
   - [tldr-viewer](https://github.com/gianasista/tldr-viewer), available on
     [Google Play](https://play.google.com/store/apps/details?id=de.gianasista.tldr_viewer)
   - [tldroid](https://github.com/hidroh/tldroid), available on
     [Google Play](https://play.google.com/store/apps/details?id=io.github.hidroh.tldroid)
+- [Bash client](https://github.com/raylee/tldr)
+- [C++ client](https://github.com/tldr-pages/tldr-cpp-client): `brew install tldr-pages/tldr/tldr`
+- [Crystal client](https://github.com/porras/tlcr): `brew install porras/tap/tlcr`
+- [Dart client](https://github.com/hterkelsen/tldr): `pub global activate tldr`
+- [Elixir client](https://github.com/tldr-pages/tldr_elixir_client) (binaries not yet available)
+- [Emacs client](https://github.com/kuanyui/tldr.el)
+- [Go client](https://github.com/pranavraja/tldr): `go get github.com/pranavraja/tldr` (or [platform binaries](https://github.com/pranavraja/tldr/releases))
 - iOS clients:
-  - [tldr-man-page](https://github.com/freesuraj/TLDR), available on
+  - [tldr-man-page](https://github.com/freesuraj/TLDR), available on [App Store](https://appsto.re/sg/IQ0-_.i)
-    [App Store](https://appsto.re/sg/IQ0-_.i)
+  - [tldr-pages](https://github.com/mflint/ios-tldr-viewer), available on [App Store](https://itunes.apple.com/us/app/tldt-pages/id1071725095?ls=1&mt=8)
-  - [tldr-pages](https://github.com/mflint/ios-tldr-viewer), available on
+- [Node.js client](https://github.com/tldr-pages/tldr-node-client) : `npm install -g tldr`
-  [App Store](https://itunes.apple.com/us/app/tldr-pages/id1071725095?ls=1&mt=8)
+- [Perl5 client](https://github.com/shoichikaji/perl-tldr): `cpanm App::tldr`
+- Python clients:
+  - [tldr-python-client](https://github.com/tldr-pages/tldr-python-client) : `pip install tldr`
+  - [tldr.py](https://github.com/lord63/tldr.py): `pip install tldr.py`
+- [R client](https://github.com/kirillseva/tldrrr): `devtools::install_github('kirillseva/tldrrr')`
 - [Ruby client](https://github.com/YellowApple/tldrb): `gem install tldrb`
 - Rust clients:
     - [rust-tldr](https://github.com/rilut/rust-tldr) (online lookup): `cargo install tldr`
     - [tldr-rs](https://github.com/dbrgn/tldr-rs) (offline caching, not yet published)
-- [R client](https://github.com/kirillseva/tldrrr): `devtools::install_github('kirillseva/tldrrr')`
-- [Dart client](https://github.com/hterkelsen/tldr): `pub global activate tldr`
 - [Web client](https://github.com/ostera/tldr.jsx): https://ostera.github.io/tldr.jsx
-- [Perl5 client](https://github.com/shoichikaji/perl-tldr): `cpanm App::tldr`
-- [Emacs client](https://github.com/kuanyui/tldr.el)
-- [Bash client](https://github.com/raylee/tldr)
-- [Crystal client](https://github.com/porras/tlcr): `brew install porras/tap/tlcr`
 
-There is also a comprehensive [list of clients in Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients).
+There is also a comprehensive [list of clients in our Wiki](https://github.com/tldr-pages/tldr/wiki/TLDR-clients).
 
 ## Contributing
 
@@ -86,3 +80,9 @@ and go ahead!
 - [Cheat](https://github.com/chrisallenlane/cheat) allows you to create and view interactive cheatsheets on the command-line. It was designed to help remind *nix system administrators of options for commands that they use frequently, but not frequently enough to remember.
 
 - [Bro pages](http://bropages.org/) are a highly readable supplement to man pages. Bro pages show concise, common-case examples for Unix commands.
+
+## What does tldr mean?
+
+TL;DR stands for "Too Long; Didn't Read".
+It originates in Internet slang, where it is used to indicate parts of the text skipped as too lengthy.
+Read more in the [TLDR article on Wikipedia](https://en.wikipedia.org/wiki/TL;DR).