online training, source, and more compose functions

CHANGELOG.md

@@ -8,11 +8,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Todo
 - update parse for style string that drops empty style of '-'
 
+## [1.2.0] - 2020-02-27
 ### Fixed
-- documentation for key2id and id2key
-
-### Changed
-- updated comments before js library
+- documentation for library, module, and functions
+correct module and function names
+- parse style for parsing non-style strings
+- compose functions with empty call
+### Added
+- original source JavaScript
+- link to online training
+- fsw.compose and swu.compose functions
 
 ## [1.1.0] - 2019-12-05
 ### Added
@@ -28,6 +33,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - documentation
 
 
-[Unreleased]: https://github.com/sutton-signwriting/core/compare/v1.1.0...HEAD
-[1.1.0]: https://github.com/sutton-signwriting/core/compare/v1.1.0...v1.0.2
+[Unreleased]: https://github.com/sutton-signwriting/core/compare/v1.2.0...HEAD
+[1.2.0]: https://github.com/sutton-signwriting/core/releases/tag/v1.2.0
+[1.1.0]: https://github.com/sutton-signwriting/core/releases/tag/v1.1.0
 [1.0.2]: https://github.com/sutton-signwriting/core/releases/tag/v1.0.2

README.md

@@ -4,38 +4,57 @@
 [![version](https://img.shields.io/npm/v/@sutton-signwriting/core)](https://www.npmjs.com/package/@sutton-signwriting/core)
 [![npm downloads](https://img.shields.io/npm/dm/@sutton-signwriting/core)](https://npm-stat.com/charts.html?package=@sutton-signwriting/core&from=2019-10-31)
 
+<img alt="Core Package Mindmap" src="./Core.jpg" width="100%">
+
 @sutton-signwriting/core is a javascript package for node and browsers that supports general processing of SignWriting text.
 
 This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets, along with the associated query languages and style string.  See [draft-slevinski-formal-signwriting](https://tools.ietf.org/id/draft-slevinski-formal-signwriting-07.html) for detailed specification.
 
+> Author: https://SteveSlevinski.me  
+> Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow  
+> Support: https://www.patreon.com/signwriting  
+
 ## Useful links
 
-- GitHub Repo: https://github.com/sutton-signwriting/core
+- Source: https://github.com/sutton-signwriting/core
+- Distribution: https://unpkg.com/browse/@sutton-signwriting/core/
 - Documentation: https://sutton-signwriting.github.io/core/
 - Issue Tracker: https://github.com/sutton-signwriting/core/issues
 - Online Discussion: https://gitter.im/sutton-signwriting/community
+- Online Training: https://katacoda.com/sutton-signwriting/courses/core
+
+## Types of files
+The source is written in small ES Modules available in the `src` directory along with the associated tests.
 
+The distribution is available in three flavors.  20 KB for the whole library minified.  Individual modules as small as 3 KB.
+* .js - Universal Module Definition
+* .cjs - CommonJS
+* .mjs - ES Module 
 
 ## Installation
 
-### Install with NPM
+### Download and Install with NPM
 
     npm install @sutton-signwriting/core
 
-### Download from GitHub
+## Developer Installation
 
-    https://github.com/sutton-signwriting/core/archive/master.zip
+### Download from GitHub and Install Development Dependencies
 
+    wget https://github.com/sutton-signwriting/core/archive/master.zip
+    unzip master.zip
+    cd core-master
+    npm install
 
 ## Usage
 
 ### Using in Node
 
     // import entire library
-    const core = require('@sutton-signwriting/core);
+    const core = require('@sutton-signwriting/core');
 
     // import individual module
-    const fsw = require('@sutton-signwriting/core/fsw);
+    const fsw = require('@sutton-signwriting/core/fsw');
 
 ### Using in the Browser
 
@@ -51,11 +70,11 @@ This package supports both Formal SignWriting in ASCII (FSW) and SignWriting in
 #### Unpkg
     // import entire library
     // available as ssw.core
-    <script src="https://unpkg.com/@sutton-signwriting/core@1.0.0"></script>
+    <script src="https://unpkg.com/@sutton-signwriting/core@1.2.0"></script>
 
     // import individual module
     // available as ssw.fsw
-    <script src="https://unpkg.com/@sutton-signwriting/core@1.0.0/fsw/fsw.js"></script>
+    <script src="https://unpkg.com/@sutton-signwriting/core@1.2.0/fsw/fsw.js"></script>
 
 ## License
 MIT