1 | # @sutton-signwriting/core
|
2 |
|
3 | [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/sutton-signwriting/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
4 | [![version](https://img.shields.io/npm/v/@sutton-signwriting/core)](https://www.npmjs.com/package/@sutton-signwriting/core)
|
5 | [![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)
|
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-09.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://www.sutton-signwriting.io/core/
|
22 | - Issue Tracker: https://github.com/sutton-signwriting/core/issues
|
23 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
24 |
|
25 | ## Types of files
|
26 | The source is written in small ES Modules available in the `src` directory along with the associated tests.
|
27 |
|
28 | The distribution is available in three flavors. 26 KB for the whole library minified. Individual modules as small as 3 KB.
|
29 | * .js - Universal Module Definition
|
30 | * .cjs - CommonJS
|
31 | * .mjs - ES Module
|
32 |
|
33 | ## Installation
|
34 |
|
35 | ### Download and Install with NPM
|
36 |
|
37 | npm install @sutton-signwriting/core
|
38 |
|
39 | ## Developer Installation
|
40 |
|
41 | ### Download from GitHub and Install Development Dependencies
|
42 |
|
43 | wget https://github.com/sutton-signwriting/core/archive/master.zip
|
44 | unzip master.zip
|
45 | cd core-master
|
46 | npm install
|
47 |
|
48 | ## Usage
|
49 |
|
50 | ### Using in Node
|
51 |
|
52 | // import entire library
|
53 | const core = require('@sutton-signwriting/core');
|
54 |
|
55 | // import individual module
|
56 | const fsw = require('@sutton-signwriting/core/fsw');
|
57 |
|
58 | ### Using in the Browser
|
59 |
|
60 | #### Local files
|
61 | // import entire library
|
62 | // available as ssw.core
|
63 | <script src="core.js"></script>
|
64 |
|
65 | // import individual module
|
66 | // available as ssw.fsw
|
67 | <script src="fsw/fsw.js"></script>
|
68 |
|
69 | #### Unpkg
|
70 | // import entire library
|
71 | // available as ssw.core
|
72 | <script src="https://unpkg.com/@sutton-signwriting/core@1.4.1"></script>
|
73 |
|
74 | // import individual module
|
75 | // available as ssw.fsw
|
76 | <script src="https://unpkg.com/@sutton-signwriting/core@1.4.1/fsw/fsw.js"></script>
|
77 |
|
78 | ## License
|
79 | MIT
|
80 |
|
81 | ## SignWriting General Interest
|
82 | - SignWriting Website: https://signwriting.org/
|
83 | - Sutton SignWriting Resources: https://www.sutton-signwriting.io/
|
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/
|