occam-styles 4.0.92 → 4.1.6

package/README.md

@@ -1,16 +1,49 @@
 # Occam Styles
 
-[Occam](https://github.com/djalbat/occam)'s colours, syntax schemes and common styles.
+[Occam](https://github.com/djalbat/occam)'s colours, syntax schemes, common styles and images.
 
 ### Contents
 
 - [Introduction](#introduction)
+- [Installation](#installation)
+- [Building](#building)
 - [Acknowledgements](#acknowledgements)
 - [Contact](#contact)
 
 ## Introduction
 
-This package contains colour definitions together with user interface and syntax schemes. It also contains the Occam logo, both as a conventional and a JavaScript SVG. A distribution of [FiraCode](https://github.com/tonsky/FiraCode) is also included.
+This package contains colour definitions together with user interface and syntax schemes. It also contains various images, both in native and JSX form. A distribution of [FiraCode](https://github.com/tonsky/FiraCode) is also included.
+
+There is a small example application to view the images in JSX form.
+
+## Installation
+
+With [npm](https://www.npmjs.com/):
+
+    npm install occam-styles
+
+You can also clone the repository with [Git](https://git-scm.com/)...
+
+    git clone https://github.com/djalbat/occam-styles.git
+
+...and then install the dependencies with npm from within the project's root directory:
+
+    npm install
+
+You can also run a development server, see the section on building later on.
+
+## Building
+
+Automation is done with [npm scripts](https://docs.npmjs.com/misc/scripts), have a look at the `package.json` file. The pertinent commands are:
+
+    npm run build-debug
+    npm run watch-debug
+
+You can also start a small development server:
+
+    npm start
+
+The example will then be available at http://localhost:8888 and will reload automatically when changes are made.
 
 ## Acknowledgements
 

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);