occam-directed-graphs 3.0.53 → 3.0.58

package/README.md

@@ -6,6 +6,7 @@
 
 - [Introduction](#introduction)
 - [Installation](#installation)
+- [Example](#example)
 - [Usage](#usage)
 - [Building](#building)
 - [Running the tests](#running-the-tests)
@@ -30,6 +31,24 @@ You can also clone the repository with [Git](https://git-scm.com/)...
 
     npm install
 
+## Example
+
+There is a small development server that can be run from within the project's directory with the following command:
+
+    npm start
+
+The example will then be available at the following URL:
+
+http://localhost:8888
+
+The source for the example can be found in the `src/example.js` file. You are encouraged to try the example whilst reading what follows. You can rebuild it on the fly with the following command:
+
+    npm run watch-debug
+
+The development server will reload the page whenever you make changes.
+
+One last thing to bear in mind is that this package is included by way of a relative rather than a package import. If you are importing it into your own application, however, you should use the standard package import.
+
 ## Usage
     
 An empty directed graph can be created by calling the `fromNothing()` factory method:

package/bin/main.js

@@ -0,0 +1,15 @@
+"use strict";
+
+const express = require("express");
+
+const { createLiveReloadHandler } = require("lively-cli");
+
+const server = express(), ///
+      staticRouter = express.static("."),
+      liveReloadHandler = createLiveReloadHandler("./example.js");
+
+server.use(staticRouter);
+
+server.get("/live-reload", liveReloadHandler);
+
+server.listen(8888);