Merge pull request #403 from andygup/v2.14.0.1

v2.14.0.1
Esri · Aug 17, 2015 · 3a24149 · 3a24149
2 parents 07bfc54 + 00ecf9d
commit 3a24149
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,14 @@
 # offline-editor-js - Changelog
 
+## Version 2.14.0.1 - Aug. 17, 2015
+
+No breaking changes. Doc updates only.
+
+**Enhancements**
+* Created separate section in README for Supported Browsers 
+* Updated Supported Browsers section in /demo/index.html
+* Removed references to local storage in /doc/dependencies.md
+
 ## Version 2.14 - Aug. 14, 2015
 
 No breaking changes. 

diff --git a/README.md b/README.md
@@ -66,13 +66,15 @@ Go __[here](https://github.com/Esri/offline-editor-js/wiki/FAQ)__ for answers to
 * Attachments are supported with some limitations listed [here](./doc/attachments.md).
 * Browser storage space on mobile devices is a known limitation. This applies to stand-alone web applications and hybrid applications.
 
+## Supported browsers
+* Only the latest versions of Chrome, Firefox and Safari are supported.  
+* The most up to date information on this library's browser support can be found [here](http://esri.github.io/offline-editor-js/demo/index.html#support).
+
 ##Dependencies
 
 * ArcGIS API for JavaScript (v3.12+)
 * Node.js required for building the source
 * NOTE: browser limitations and technical dependencies. The offline capabilities in this toolkit depend on certain HTML5 capabilities being present in the browser. Go [here](doc/dependencies.md) for a detailed breakdown of the information.
-* We only offer browser support for the latest versions of Chrome, Firefox and Safari only.  	
-
 * Sub-modules (see `/vendor` directory)
 
    * [offline.js](https://github.com/hubspot/offline) - it allows detection of the online/offline condition and provides events to hook callbacks on when this condition changes

diff --git a/demo/index.html b/demo/index.html
@@ -121,7 +121,7 @@ <h3>AppCache Tiles Only</h3>
         </div>
     </div>
 
-    <div class="bs-docs-section">
+    <div class="bs-docs-section" id="support">
         <h1 id="examples" class="page-header">Supported Browsers</h1>
         <p class="lead">The offline libraries are supported on the <strong>latest versions</strong> of the following browsers and operating systems.<br>
         </p>
@@ -132,31 +132,35 @@ <h1 id="examples" class="page-header">Supported Browsers</h1>
                 <th>Chrome</th>
                 <th>Firefox</th>
                 <th>Internet Explorer</th>
+                <th>Edge</th>
                 <th>Opera</th>
                 <th>Safari</th>
             </tr>
             </thead>
             <tbody>
             <tr>
                 <th>Android</th>
-                <td class="text-success"><span class="glyphicon glyphicon-ok">+</span> <span class="sr-only">Supported</span></td>
+                <td class="text-success"><span class="glyphicon glyphicon-ok"></span> <span class="sr-only">Supported</span></td>
                 <td class="text-success"><span class="glyphicon glyphicon-ok"></span> <span class="sr-only">Supported</span></td>
                 <td class="text-muted" rowspan="3" style="vertical-align: middle;">N/A</td>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
+                <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
                 <td class="text-muted">N/A</td>
             </tr>
             <tr>
                 <th>iOS</th>
                 <td class="text-success"><span class="glyphicon glyphicon-ok"></span> <span class="sr-only">Supported</span></td>
                 <td class="text-muted">N/A</td>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
+                <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
                 <td class="text-success"><span class="glyphicon glyphicon-ok">*</span> <span class="sr-only">Supported</span></td>
             </tr>
             <tr>
                 <th>Mac OS X</th>
                 <td class="text-success"><span class="glyphicon glyphicon-ok"></span> <span class="sr-only">Supported</span></td>
                 <td class="text-success"><span class="glyphicon glyphicon-ok"></span> <span class="sr-only">Supported</span></td>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
+                <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
                 <td class="text-success"><span class="glyphicon glyphicon-ok">*</span> <span class="sr-only">Supported</span></td>
             </tr>
             <tr>
@@ -166,16 +170,22 @@ <h1 id="examples" class="page-header">Supported Browsers</h1>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
                 <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
+                <td class="text-danger"><span class="glyphicon glyphicon-remove"></span> <span class="sr-only">Not Supported</span></td>
             </tr>
             </tbody>
          </table>
-        <p class="lead">Hybrid app developers (e.g. PhoneGap\Cordova) targeting Android: we currently only support the Chrome browser.
+        <p class="lead"><strong>Important note for Hybrid app developers (e.g. PhoneGap\Cordova):</strong> this library is <strong>not supported</strong> for hybrid deployments.
+            There are too many different variations of iOS and Android to make this feasible.
             We've only done very limited proof-of-concept testing using WebView.
             Make sure you do thorough testing on as many different phones and tablets as possible.
             One suggestion is to build a test app and run the Unit Test suite which is in this project under /test.
         </p>
-        <span class="text-success"><span class="glyphicon glyphicon-ok">+</span></span> - Currently only the Chrome browser is supported on Android. <br>
+        <p class="lead">
+            <strong>Windows developers:</strong> Edge is under consideration for developement support-only. However, at this time I don't have
+            a machine that runs it.
+        </p>
         <span class="text-success"><span class="glyphicon glyphicon-ok">*</span></span> - means that <a href="https://github.com/axemclion/IndexedDBShim"> IndexedDBShim.js</a> may be required on this browser/platform. More info available in the <a href="https://github.com/Esri/offline-editor-js"> README </a> under Dependencies.
+        <p></p><p></p>
     </div>
 
 </div>

diff --git a/doc/dependencies.md b/doc/dependencies.md
@@ -3,8 +3,7 @@ Technical Dependencies
 
 The offline-editor-js projects includes but is not limited to the following dependencies:
 
-* localStorage. The limits vary by browser and is typically 5MBs per domain name. For additional information see W3C's webstorage specification, [Section 5](http://www.w3.org/TR/webstorage/).
-* indexedDB. Storage limits for indexedDB are not necessarily consistent across browsers. It's generally understood to be 50MB. Here is a Mozilla [document](https://developer.mozilla.org/en-US/docs/IndexedDB#Storage_limits) discussing limits across different browsers. 
+* indexedDB. Storage limits for indexedDB are not necessarily consistent across browsers. Here is a Mozilla [document](https://developer.mozilla.org/en-US/docs/IndexedDB#Storage_limits) discussing limits across different browsers. 
 * Advanced users of the library should be aware that JavaScript stores some strings as UTF-16. More information can be found in this Mozilla [article](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String/length).
 * If a user completely flushes their browser cache all queued edits, tiles as well as anything stored in local storage, IndexedDB, SQLite or even the appcache will most likely be lost.
 * Data stored by the library should persist if the browser is shutdown and restarted. However, this does not mean that your application will be returned to its correct state. A client web application's state has to be programmatically managed. This includes the state of items including but not limited to feature layers within your application.