Index: third_party/polymer/platform/README.md |
diff --git a/third_party/polymer/platform/README.md b/third_party/polymer/platform/README.md |
index f2a9e63f10e3815681ebe0402d3c3051c6b58408..b9133118edc0f56bdeddf27f4e2b3568e5135395 100644 |
--- a/third_party/polymer/platform/README.md |
+++ b/third_party/polymer/platform/README.md |
@@ -1,4 +1,98 @@ |
-Platform |
-======== |
+# Platform.js <sup>v1.0.0</sup> |
-Aggregated polyfills the Polymer platform. |
+A platform detection library that works on nearly all JavaScript platforms<sup><a name="fnref1" href="#fn1">1</a></sup>. |
+ |
+## Disclaimer |
+ |
+Platform.js is for informational purposes only and **not** intended as a substitution for [feature detection/inference](http://allyoucanleet.com/post/18087210413/feature-testing-costs#screencast2) checks. |
+ |
+## BestieJS |
+ |
+Platform.js is part of the BestieJS *"Best in Class"* module collection. This means we promote solid browser/environment support, ES5 precedents, unit testing, and plenty of documentation. |
+ |
+## Documentation |
+ |
+The documentation for Platform.js can be viewed here: [/doc/README.md](https://github.com/bestiejs/platform.js/blob/master/doc/README.md#readme) |
+ |
+For a list of upcoming features, check out our [roadmap](https://github.com/bestiejs/platform.js/wiki/Roadmap). |
+ |
+## Support |
+ |
+Platform.js has been tested in at least Adobe AIR 3.1, Chrome 5-21, Firefox 1.5-13, IE 6-9, Opera 9.25-12.01, Safari 3-6, Node.js 0.8.6, Narwhal 0.3.2, RingoJS 0.8, and Rhino 1.7RC5. |
+ |
+## Installation and usage |
+ |
+In a browser or Adobe AIR: |
+ |
+```html |
+<script src="platform.js"></script> |
+``` |
+ |
+Via [npm](http://npmjs.org/): |
+ |
+```bash |
+npm install platform |
+``` |
+ |
+In [Node.js](http://nodejs.org/) and [RingoJS](http://ringojs.org/): |
+ |
+```js |
+var platform = require('platform'); |
+``` |
+ |
+In [Rhino](http://www.mozilla.org/rhino/): |
+ |
+```js |
+load('platform.js'); |
+``` |
+ |
+In an AMD loader like [RequireJS](http://requirejs.org/): |
+ |
+```js |
+require({ |
+ 'paths': { |
+ 'platform': 'path/to/platform' |
+ } |
+}, |
+['platform'], function(platform) { |
+ console.log(platform.name); |
+}); |
+``` |
+ |
+Usage example: |
+ |
+```js |
+// on IE10 x86 platform preview running in IE7 compatibility mode on Windows 7 64 bit edition |
+platform.name; // 'IE' |
+platform.version; // '10.0' |
+platform.layout; // 'Trident' |
+platform.os; // 'Windows Server 2008 R2 / 7 x64' |
+platform.description; // 'IE 10.0 x86 (platform preview; running in IE 7 mode) on Windows Server 2008 R2 / 7 x64' |
+ |
+// or on an iPad |
+platform.name; // 'Safari' |
+platform.version; // '5.1' |
+platform.product; // 'iPad' |
+platform.manufacturer; // 'Apple' |
+platform.layout; // 'WebKit' |
+platform.os; // 'iOS 5.0' |
+platform.description; // 'Safari 5.1 on Apple iPad (iOS 5.0)' |
+ |
+// or parsing a given UA string |
+var info = platform.parse('Mozilla/5.0 (Macintosh; Intel Mac OS X 10.7.2; en; rv:2.0) Gecko/20100101 Firefox/4.0 Opera 11.52'); |
+info.name; // 'Opera' |
+info.version; // '11.52' |
+info.layout; // 'Presto' |
+info.os; // 'Mac OS X 10.7.2' |
+info.description; // 'Opera 11.52 (identifying as Firefox 4.0) on Mac OS X 10.7.2' |
+``` |
+ |
+## Author |
+ |
+* [John-David Dalton](http://allyoucanleet.com/) |
+ [](https://twitter.com/jdalton "Follow @jdalton on Twitter") |
+ |
+## Contributors |
+ |
+* [Mathias Bynens](http://mathiasbynens.be/) |
+ [](https://twitter.com/mathias "Follow @mathias on Twitter") |