Cleanup towards release

Author: andygill

CHANGELOG.md

@@ -1,2 +1,3 @@
-## 0.1
-* First release
+## 0.2
+* First public release
+

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2016, Andy Gill
+Copyright (c) 2016-2019, The University of Kansas
 
 All rights reserved.
 
@@ -13,7 +13,7 @@ modification, are permitted provided that the following conditions are met:
       disclaimer in the documentation and/or other materials provided
       with the distribution.
 
-    * Neither the name of Andy Gill nor the names of other
+    * Neither the name of The University of Kansas nor the names of other
       contributors may be used to endorse or promote products derived
       from this software without specific prior written permission.
 

README.md

@@ -1,15 +1,14 @@
 # javascript-bridge [![Build Status](https://img.shields.io/travis/ku-fpg/javascript-bridge.svg?style=flat)](https://travis-ci.org/ku-fpg/javascript-bridge)
 
-**javascript-bridge** is an easy way of calling JavaScript from
-Haskell, using web-sockets as the underlying transport
+**javascript-bridge** is a straightforward way of calling JavaScript
+from Haskell, using web-sockets as the underlying transport
 mechanism. Conceptually, javascript-bridge gives Haskell acccess to
-the JavaScript `eval` function.  However, using a remote monad, as
-well as supporting evaluation of JavaScript fragments, we also support
-calling and returning values from JavaScript functions, constructing
-and using remote objects, and sending events from JavaScript to
-Haskell.
+the JavaScript `eval` function.  However, we also support calling and
+returning values from JavaScript functions, constructing and using
+remote objects, and sending events from JavaScript to Haskell, all
+using a remote monad.
 
-# High-level overview of API
+# Overview of API
 
 **javascript-bridge** remotely executes JavaScript *fragments*.
 The basic Haskell idiom is.
@@ -45,8 +44,8 @@ then listening for the event in Haskell.
 ```Haskell
   do -- Have JavaScript send an event to Haskell
      send eng $ command $ "event('Hello!')"
-     -- Have Haskell wait for the event
-     e :: String <- listen eng
+     -- Have Haskell wait for the event, which is an Aeson 'Value'.
+     e :: Value <- listen eng
      print e
 ```
 
@@ -67,13 +66,12 @@ app :: Engine -> IO ()
 app = send eng $ command "console.log('Hello!')"
 ```
 
-Next, include the following fragment in your HTML code,
-replacing *localhost* with your web address.
+Next, include the following fragment in your HTML code.
 
 ```HTML
     <script>
-        jsb = new WebSocket('ws://localhost:3000/');
-        jsb.onmessage = function(evt){ eval(evt.data);};
+        window.jsb = {ws: new WebSocket('ws://' + location.host)};
+	jsb.ws.onmessage = (evt) => eval(evt.data);
     </script>
 ```
 

examples/Main.html

@@ -10,7 +10,7 @@ <h2>Example</h2>
     <div id="target"></div>
     <script>
       // Bootstrap code
-      window.jsb = {ws: new WebSocket('ws://' + location.host + '/')};
+      window.jsb = {ws: new WebSocket('ws://' + location.host)};
       jsb.ws.onmessage = (evt) => eval(evt.data);
       // Debugging to JavaScript console
       jsb.debug = true;

examples/Multi.hs

@@ -94,7 +94,7 @@ applet eng Promises = do
     render $ show (p2 :: String, p3 :: String)
   send eng $ do
     -- constructors create remote handles, and the
-    -- handle can be a promise, and is constructed
+    -- handle can be a promise, and is returned
     -- immeduately.
     p2 <- constructor $
       "new Promise((resolve,reject) => {" <>

javascript-bridge.cabal

@@ -30,14 +30,12 @@ library
                        Network.JavaScript.Services
   build-depends:       base                 >= 4.9     && < 4.14
                      , binary               >= 0.8     && < 0.9
-                     , aeson                >= 1.0     && < 1.5
+                     , aeson                >= 1.4     && < 1.5
                      , containers           >= 0.5     && < 0.7
-                     , scientific           >= 0.3.4.9 && < 0.4
                      , stm                  >= 2.4     && < 2.6
                      , text                 >= 1.2     && < 1.3
                      , time                 >= 1.6     && < 1.10                     
                      , transformers         >= 0.4     && < 0.6
-                     , unordered-containers >= 0.2.7   && < 0.3
                      , wai                  >= 3.2     && < 3.3
                      , wai-websockets       >= 3.0.1   && < 3.1
                      , websockets           >= 0.10    && < 0.13

src/Network/JavaScript/Internal.hs

@@ -33,7 +33,6 @@ module Network.JavaScript.Internal
 import           Data.Aeson (ToJSON(..), FromJSON(..))
 import qualified Data.Aeson.Encoding.Internal as AI
 import qualified Data.Binary.Builder as B
-import           Data.Semigroup
 import           Data.Text.Lazy(Text, pack)
 import           Data.Text.Lazy.Encoding(encodeUtf8)
 import           Data.String

stack.yaml

@@ -15,7 +15,7 @@
 # resolver:
 #  name: custom-snapshot
 #  location: "./custom-snapshot.yaml"
-resolver: lts-8.9
+resolver: lts-13.6
 
 # User packages to be built.
 # Various formats can be used as shown in the example below.

test/Main.hs

@@ -56,7 +56,7 @@ main_ i = do
                , T.pack (table tests)
                , "</div>"
                ,   "<script>"
-               ,     "window.jsb = {ws: new WebSocket('ws://' + location.host + '/')};"
+               ,     "window.jsb = {ws: new WebSocket('ws://' + location.host)};"
                ,     "jsb.ws.onmessage = (evt) => eval(evt.data);"
                     -- remote object to allow interesting commands and procedures
                ,     "var remote = [];"