Adding readme.txt for WordPress's plugin directory

readme.txt

@@ -0,0 +1,49 @@
+=== Plugin Name ===
+Contributors: davidwalsh83
+Donate link: https://davidwalsh.name
+Tags: performance, caching, offline
+Requires at least: 3.0.1
+Tested up to: 4.4.2
+Stable tag: 0.1.0
+License: GPLv2 or later
+License URI: http://www.gnu.org/licenses/gpl-2.0.html
+
+A WordPress plugin for caching theme assets via a service worker for the sake of performance and offline functionality.
+
+== Description ==
+
+WordPress Service Worker Cache is a plugin for using the [ServiceWorker API](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API/Using_Service_Workers "Learn more") to cache theme files for performance and offline purposes.
+
+The WordPress admin can select which files to cache, update the cache list at any time, and see their site performance improve while ensuring important assets are available offline.
+
+== Installation ==
+
+Installation of the plugin is simple:
+
+1. Upload the plugin files to the `/wp-content/plugins/wp-sw-cache` directory, or install the plugin through the WordPress plugins screen directly.
+2. Activate the plugin through the 'Plugins' screen in WordPress
+3. Use the Settings->WP SW Cache screen to configure the plugin
+4. Check the "Enable Service Worker" checkbox and then select individual files you'd like cached.  These assets should be files you use on most pages.
+
+== Frequently Asked Questions ==
+
+= Does this plugin allow for offline reading of content? =
+
+No, but couple this plugin with the [Offline Content](https://wordpress.org/plugins/offline-content/) plugin and you can have functioning pages and assets offline.
+
+= Does this plugin modify my theme files? =
+
+Absolutely not -- no files are modified or generated by this plugin.
+
+= When should the theme file options be updated? =
+
+It's best to update the plugin file options when you've added a new file to your theme that you'd like cached.  Files that change or are deleted will be automatically detected and will not create problems witin the service worker.
+
+= Can I provide feedback? =
+
+Of course! Service Workers are an emerging technology so this plugin should be updated often based on feedback from developers using WordPress in different ways
+
+== Changelog ==
+
+= 0.1 =
+* Initial release of plugin