| 1 | # @sutton-signwriting/core
|
| 2 |
|
| 3 | [](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
| 4 | [](https://www.npmjs.com/package/@sutton-signwriting/core)
|
| 5 | [](https://npm-stat.com/charts.html?package=@sutton-signwriting/core&from=2019-10-31)
|
| 6 |
|
| 7 | <img alt="Core Package Mindmap" src="./Core.jpg" width="100%">
|
| 8 |
|
| 9 | @sutton-signwriting/core is a javascript package for node and browsers that supports general processing of SignWriting text.
|
| 10 |
|
| 11 | 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.
|
| 12 |
|
| 13 | > Author: https://SteveSlevinski.me
|
| 14 | > Channel: https://www.youtube.com/channel/UCXu4AXlG0rXFtk_5SzumDow
|
| 15 | > Support: https://www.patreon.com/signwriting
|
| 16 |
|
| 17 | ## Useful links
|
| 18 |
|
| 19 | - Source: https://github.com/sutton-signwriting/core
|
| 20 | - Distribution: https://unpkg.com/browse/@sutton-signwriting/core/
|
| 21 | - Documentation: https://sutton-signwriting.github.io/core/
|
| 22 | - Issue Tracker: https://github.com/sutton-signwriting/core/issues
|
| 23 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
| 24 | - Online Training: https://katacoda.com/sutton-signwriting/courses/core
|
| 25 |
|
| 26 | ## Types of files
|
| 27 | The source is written in small ES Modules available in the `src` directory along with the associated tests.
|
| 28 |
|
| 29 | The distribution is available in three flavors. 20 KB for the whole library minified. Individual modules as small as 3 KB.
|
| 30 | * .js - Universal Module Definition
|
| 31 | * .cjs - CommonJS
|
| 32 | * .mjs - ES Module
|
| 33 |
|
| 34 | ## Installation
|
| 35 |
|
| 36 | ### Download and Install with NPM
|
| 37 |
|
| 38 | npm install @sutton-signwriting/core
|
| 39 |
|
| 40 | ## Developer Installation
|
| 41 |
|
| 42 | ### Download from GitHub and Install Development Dependencies
|
| 43 |
|
| 44 | wget https://github.com/sutton-signwriting/core/archive/master.zip
|
| 45 | unzip master.zip
|
| 46 | cd core-master
|
| 47 | npm install
|
| 48 |
|
| 49 | ## Usage
|
| 50 |
|
| 51 | ### Using in Node
|
| 52 |
|
| 53 | // import entire library
|
| 54 | const core = require('@sutton-signwriting/core');
|
| 55 |
|
| 56 | // import individual module
|
| 57 | const fsw = require('@sutton-signwriting/core/fsw');
|
| 58 |
|
| 59 | ### Using in the Browser
|
| 60 |
|
| 61 | #### Local files
|
| 62 | // import entire library
|
| 63 | // available as ssw.core
|
| 64 | <script src="core.js"></script>
|
| 65 |
|
| 66 | // import individual module
|
| 67 | // available as ssw.fsw
|
| 68 | <script src="fsw/fsw.js"></script>
|
| 69 |
|
| 70 | #### Unpkg
|
| 71 | // import entire library
|
| 72 | // available as ssw.core
|
| 73 | <script src="https://unpkg.com/@sutton-signwriting/core@1.2.0"></script>
|
| 74 |
|
| 75 | // import individual module
|
| 76 | // available as ssw.fsw
|
| 77 | <script src="https://unpkg.com/@sutton-signwriting/core@1.2.0/fsw/fsw.js"></script>
|
| 78 |
|
| 79 | ## License
|
| 80 | MIT
|
| 81 |
|
| 82 | ## SignWriting General Interest
|
| 83 | - SignWriting Website: https://signwriting.org/
|
| 84 | - Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
|
| 85 | - Email Discussion: https://www.signwriting.org/forums/swlist/
|
| 86 | - Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
|