Note: this project has been archived, as development has stalled, and it isn't being actively maintained, nor used.

[![Build Status](https://travis-ci.org/mozilla/wp-offline-shell.svg?branch=master)](https://travis-ci.org/mozilla/wp-offline-shell)
[![WordPress plugin](https://img.shields.io/wordpress/plugin/v/offline-shell.svg)](https://wordpress.org/plugins/offline-shell/) [![WordPress](https://img.shields.io/wordpress/plugin/dt/offline-shell.svg)](https://wordpress.org/plugins/offline-shell/)

> **IMPORTANT**: I'm very sorry to announce this plugin is **unmaintained** thought it is still compatible with WordPress up to version 4.4.10.

# Offline Shell
A WordPress plugin for caching theme assets via a service worker for the sake of performance and offline functionality.

## Build

To build the plugin, ensure you have [Composer](https://getcomposer.org/),
then simply invoke `composer install`.

## Installation and Usage

Assuming the build step completed successfully, place the `wp-offline-shell` directory inside your WordPress instance's `wp-content/plugins directory`.

With the plugin in the WordPress directory structure:

  1.  Activate the plugin
  2.  Navigate to the plugin's settings page
  3.  Choose assets from the listing that are used most frequently (`style.css` is likely used on every page of the blog, for example)
  4.  Save!

A service worker will then be placed within every page of the blog and select assets will be served from the service worker!

## Install the plugin

Clone the repository and copy the folder `wp-offline-content` inside your WordPress `plugins` directory.

Activate the plugin from the _Plugins_ menu in the _Dashboard_. Options are available to customize under the _Offline content_ submenu in _Settings_.

## Running tests

Install dependencies:
```bash
./bin/install-wp-tests.sh MYSQL_DATABASE_NAME MYSQL_USER MYSQL_PASSWORD localhost latest
```

Run tests:
```bash
make test
```

Run service worker tests:
```bash
make test-sw
```

## Contribution and Bugs

Contributions are welcome!  You can file pull requests or or issues at [this repository](https://github.com/mozilla/wp-offline-shell).

## Related WordPress Plugins

  *  [wp-offline-content](https://github.com/delapuente/wp-offline-content) - Save pages for offline reading
  *  [wp-sw-manager](https://github.com/mozilla/wp-sw-manager) - Shared service worker plugin
  *  [wp-web-push](https://github.com/mozilla/wp-web-push) - Add push notifications to your WordPress site!