Plugin -> Extension

Author: jmwohl

README.md

@@ -1,7 +1,5 @@
-> NOTE: this repo is under development. The contents is likely to change significantly.
+# Openframe Website Extension
 
-# Openframe Website Plugin
+An Openframe format extension which enables display of websites via chromium.
 
-An Openframe format plugin which enables display of websites via chromium.
-
-For info on developing your own plugins, see the [Openframe-PluginExample](https://github.com/OpenframeProject/Openframe-PluginExample) repo.
+For info on developing your own extensions, see the [Openframe-ExtensionExample](https://github.com/OpenframeProject/Openframe-ExtensionExample) repo.

extension.js

@@ -0,0 +1,34 @@
+var pjson = require('./package.json'),
+    debug = require('debug')('openframe:website'),
+    extension = module.exports = {};
+
+/**
+ * Extension initialization method.
+ *
+ * Called when the extension (and its dependencies) have been installed.
+ *
+ * @param  {object} OF An interface provided to extensions giving limitted access to the frame environment
+ */
+extension.init = function(OF) {
+    // do your extension thing
+    debug('=======>   Openframe-Website initialized!   <=======');
+
+    /**
+     * Extensions can add new artwork formats to the frame.
+     *
+     * Each format must have a unique name, which should correspond to the
+     * name of the npm package.
+     */
+    OF.addFormat(
+        {
+            // the name should be the same as the package name
+            'name': pjson.name,
+            // this is what might get displayed to users (not currently used)
+            'display_name': 'Website',
+            'download': false,
+            'start_command': 'xinit /usr/bin/chromium --kiosk $url',
+            'end_command': 'sudo pkill -f chromium'
+        }
+    );
+};
+

install.sh

@@ -2,7 +2,7 @@
 #
 # Be VERY Careful. This script may be executed with admin privileges.
 
-echo "Openframe Website Plugin -- install.sh"
+echo "Openframe Website Extension -- install.sh"
 
 # Some limited platform detection might be in order... though at present we're targeting the Pi
 os=$(uname)

package.json

@@ -1,8 +1,8 @@
 {
   "name": "openframe-website",
   "version": "0.1.0",
-  "description": "Openframe plugin which adds support for website-based artwork via chromium.",
-  "main": "plugin.js",
+  "description": "Openframe extension which adds support for website-based artwork via chromium.",
+  "main": "extension.js",
   "scripts": {
     "install": "./install.sh",
     "uninstall": "./uninstall.sh",
@@ -37,5 +37,8 @@
   "repository": {
     "type": "git",
     "url": "https://github.com/OpenframeProject/Openframe-Website"
+  },
+  "dependencies": {
+    "debug": "^2.2.0"
   }
 }

plugin.js

@@ -2,7 +2,7 @@
 #
 # Be VERY Careful. This script may be executed with admin privileges.
 
-echo "Openframe Website Plugin -- uninstall.sh"
+echo "Openframe Website -- uninstall.sh"
 
 # Some limited platform detection might be in order... though at present we're targeting the Pi
 os=$(uname)