Create README.md

README.md

@@ -0,0 +1,94 @@
+caniuse-cmd
+===========
+
+Just what you've always wanted, it's a `caniuse` command line tool!
+All the power of [caniuse.com](http://caniuse.com) with none of the nice UI or interactivity!
+
+
+How do?
+-------
+
+Install with `npm install -g caniuse-cmd`.
+
+Then type things like this:
+
+```
+$ caniuse websockets
+Web Sockets ✔ 85.22% ◒ 1.35% [W3C Candidate Recommendation]
+  Bidirectional communication technology for web apps #JSAPI
+
+  IE ✘ 5.5+ ✔ 10+
+  Firefox ✘ 2+ ◒ 4+¹ ◒ 6+ᵖ² ✔ 11+
+  Chrome ◒ 4+¹ ◒ 15+² ✔ 16+
+  Safari ✘ 3.1+ ◒ 5+¹ ◒ 6+² ✔ 7+
+  Opera ✘ 9+ ◒ 11+¹ ✔ 12.1+
+
+    ¹Partial support refers to the websockets implementation using an older version of the protocol and/or the
+    implementation being disabled by default (due to security issues with the older protocol).
+    ²Partial support refers to lacking support for binary data.
+```
+
+(The output has truly marvellous colours that this markdown is too narrow to contain.)
+
+Or this:
+
+```
+$ caniuse input
+caniuse input
+HTML5 form features ✔ 4.21% ◒ 82.39%
+  IE ✘ 5.5+ ◒ 10+ Firefox ✘ 2+ ◒ 4+ Chrome ◒  Safari ✘ 3.1+ ◒ 4+ Opera ✔ 9+ ◒ 15+
+Spellcheck attribute ✔ 60.31% ◒ 31.63%
+  IE ✘ 5.5+ ✔ 10+ Firefox ✔  Chrome ✘ 4+ ✔ 9+ Safari ✘ 3.1+ ✔ 5.1+ Opera ✘ 9+ ✔ 10.5+
+Range input type ✔ 87.46% ◒ 1.18%
+  IE ✘ 5.5+ ✔ 10+ Firefox ✘ 2+ ✔ 23+ Chrome ‽ 4+ ✔ 5+ Safari ✔  Opera ✔
+Date and time input types ✔ 60.76% ◒ 0%
+  IE ✘  Firefox ✘  Chrome ✘ 4+ ✔ 20+ Safari ✘  Opera ✔
+Color input type ✔ 60.93% ◒ 3.84%
+  IE ✘  Firefox ✘ 2+ ✔ 29+ Chrome ✘ 4+ ✔ 20+ Safari ✘  Opera ✘ 9+ ✔ 11+ ✘ 15+ ✔ 17+
+Number input type ✔ 49.95% ◒ 38.03%
+  IE ✘ 5.5+ ◒ 10+ Firefox ✘ 2+ ✔ 29+ Chrome ✘ 4+ ✔ 6+ Safari ✘ 3.1+ ✔ 5+ Opera ✔
+input placeholder attribute ✔ 88.04% ◒ 1.15%
+  IE ✘ 5.5+ ✔ 10+ Firefox ✘ 2+ ✔ 4+ Chrome ✔  Safari ◒ 3.1+ ✔ 5+ Opera ✘ 9+ ◒ 11+ ✔ 11.5+
+Pointer events ✔ 8.5% ◒ 1.67%
+  IE ✘ 5.5+ ◒ 10+ᵖ ✔ 11+ Firefox ✘  Chrome ✘  Safari ✘ 3.1+ ‽ 6.1+ Opera ✘
+Web Speech API
+  IE ✘  Firefox ✘  Chrome ✘ 4+ ◒ 25+ᵖ Safari ✘ 3.1+ ◒ 6.1+ᵖ ◒ 7.1+ Opera ✘
+Multiple file selection ✔ 67.63% ◒ 0%
+  IE ✘ 5.5+ ✔ 10+ Firefox ✘ 2+ ✔ 3.6+ Chrome ✘ 4+ ✔ 5+ Safari ✘ 3.1+ ✔ 4+ Opera ✘ 9+ ✔ 10.6+
+Gamepad API ✔ 46.08% ◒ 0%
+  IE ✘  Firefox ✘ 2+ ✔ 29+ Chrome ✘ 4+ ✔ 21+ᵖ ✔ 25+ Safari ✘  Opera ✘ 9+ ✔ 24+
+Pattern attribute for input fields ✔ 72.88% ◒ 0.7%
+  IE ✘ 5.5+ ✔ 10+ Firefox ✘ 2+ ✔ 4+ Chrome ✘ 4+ ✔ 10+ Safari ✘  Opera ✘ 9+ ✔ 9.5-9.6+
+```
+
+Does it have lots of command line options?
+------------------------------------------
+
+Yes!
+
+```
+$ caniuse --help
+Options:
+  --short            Short output: show browsers on one line and don't display
+                     notes or description (default when displaying multiple
+                     results)
+  --long             Long output: show more information (default when
+                     displaying a single result)
+  --oneline          One-line output: just global percentages, no per-browser
+                     info                                       [default: false]
+  --oneline-browser  One-line output with browser info, implies --abbrev and
+                     --current                                  [default: false]
+  --abbrev           Abbreviate browser names                   [default: false]
+  --percentages      Include browser version usage percentages  [default: false]
+  --future           Include future browser versions            [default: false]
+  --current          Don't include old browser versions, equivalent to --era e0
+                                                                [default: false]
+  --era              How many versions back to go, e0 to e-37
+  --mobile           Include mobile browsers                    [default: false]
+  --desktop          Include desktop browsers                    [default: true]
+  --browser          Show results for these browsers, comma-separated
+                     (ie,firefox,chrome,safari,opera,ios_saf,op_mini,android,op_mob,bb,and_chr,and_ff,ie_mob,and_uc)
+
+  --web              Go to the search page on caniuse.com       [default: false]
+  --help             Show help
+```