occam-styles 4.1.253 → 4.1.255

package/README.md

@@ -6,6 +6,8 @@
 
 - [Introduction](#introduction)
 - [Installation](#installation)
+- [Example](#example)
+- [Usage](#sage)
 - [Building](#building)
 - [Acknowledgements](#acknowledgements)
 - [Contact](#contact)
@@ -52,18 +54,40 @@ For instructions on how to remove all ligatures, etc, see the following:
 
 Only the regular font face is being used currently.
 
-## Building
+## Example
 
-Automation is done with [npm scripts](https://docs.npmjs.com/misc/scripts), have a look at the `package.json` file. The pertinent commands are:
+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 and corresponding `src/example` folder. You are encouraged to try the example whilst reading what follows. You can rebuild it on the fly with the following command:
 
-    npm run build-debug
     npm run watch-debug
 
-You can also start a small development server:
+The development server will reload the page whenever you make changes.
 
-    npm start
+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
+
+The various styles and elements can be importsed in the usual manner:
 
-The example will then be available at http://localhost:8888 and will reload automatically when changes are made.
+```
+import { CreateSessionToolbarSVG } from "occam-styles";
+```
+
+For a complete list see the `src/index.js` file.
+
+## 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
 
 ## Acknowledgements