README improvement and name consistency

Author: retog

README.md

@@ -1,9 +1,13 @@
-# page-to-extension-rpc
+# Scuttle Shell Browser
 
 ## What it does
 
-This projet provides a webextension an a webpage that demostrate an RPC Connection between
-page an extension.
+This projet provides a webextension that allows accessing scuttlebutt from scripts in websites.
+
+An script running on the Host provides an RPC connection to scuttlebutt via native messages. The web exension allows to decide which pages can access Scuttlebutt.
+
+
+![Context menu to enable SSB aceess](images/scuttle-shell-browser-screenshot.png)
 
 This extension includes a content script, which is injected into the accessed pages. This
 content script provides an api that can be accessed from any page using a [muxrpc](https://github.com/ssb-js/muxrpc) connection.
@@ -21,7 +25,11 @@ Building
 
 Running
 
-To run the example you need to have the extension intalle and acce the example page.
+To use Scuttle Shell Browser you need an ssb-sever running on your machine (this is the case when you
+are running Patchwork). You need to install native mesaging for the manifest in `host/scuttle_shell_browser.json`, see https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging to learn how to do this on your platform. Note that you need to adapt the paths in the manifest file and that `host/host-script.js` must be executable.
+
+
+To run the example you need to have the extension intalled and access the example page.
 
     npm run-script start:ext
 
@@ -32,6 +40,3 @@ This should start a browser with the extension. Alternatively you can also load
 Now you can access http://localhost:9090/page.html
 
 
-## What it shows
-
-How to make an RPC connection between an extension's content scripts, and scripts running in a web page.

host/ssb4all.json renamed to host/scuttle_shell_browser.json

@@ -1,7 +1,7 @@
 {
-  "name": "ssb4all",
-  "description": "A Native Messaging host that gives access to ssb to e ssb4all web extension",
+  "name": "scuttle_shell_browser",
+  "description": "A Native Messaging host that gives access to ssb to the Scuttle Shell Browser web extension",
   "path": "/home/reto/Documents/retog/ssb4all/host/host-script.js",
   "type": "stdio",
-  "allowed_extensions": [ "ssb4all@example.org" ]
+  "allowed_extensions": [ "scuttle-shell-browser@example.org" ]
 }

images/scuttle-shell-browser-screenshot.png

@@ -18,6 +18,7 @@ function notify(message) {
             connectPort(con.stream)
             portConnections[con.port.sender.tab.id].connected = true
           } else {
+            console.log(con.stream)
             con.stream.abort()
           }
         })
@@ -32,7 +33,7 @@ browser.runtime.onConnect.addListener(async function connected(port) {
   console.log('connection from', port.sender.url)
   const stream = createConnection(port)
   const relevantURL = port.sender.url.split('?')[0].split('#')[0]
-  const { granted } = await browser.storage.local.get('granted')
+  const { granted } = await browser.storage.local.get({'granted': []})
   if (~granted.indexOf(relevantURL)) {
     connectPort(stream) 
     portConnections[port.sender.tab.id] = { port, stream, connected: true }
@@ -60,7 +61,7 @@ function connectPort(contentScriptStream) {
 }
 
 function createNativeConnection() {
-  const port = browser.runtime.connectNative("ssb4all")
+  const port = browser.runtime.connectNative("scuttle_shell_browser")
   return createConnection(port)
 }
 

src/background-script.js

@@ -30,7 +30,7 @@
 
   "browser_specific_settings": {
     "gecko": {
-      "id": "scuttle-shell@example.org",
+      "id": "scuttle-shell-browser@example.org",
       "strict_min_version": "50.0"
     }
   },

webext/manifest.json

@@ -7,7 +7,7 @@ browser.tabs.query({ "active": true, "currentWindow": true, "windowType": "norma
   tab => {
     const relevantURL = tab.url.split('?')[0].split('#')[0]
     locationArea.innerText = relevantURL
-    browser.storage.local.get('granted').then(result => {
+    browser.storage.local.get({'granted': []}).then(result => {
       let granted = result.granted
       const enabled = !!~granted.indexOf(relevantURL)
       toggleSwitch.checked = enabled