UNPKG

3.39 kBMarkdownView Raw
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![Core Package Mindmap](./Core.jpg)
8
9@sutton-signwriting/core is a javascript package for node and browsers that supports general processing of SignWriting text.
10
11This 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> Donate: https://donate.sutton-signwriting.io
17
18## Useful links
19
20- Source: https://github.com/sutton-signwriting/core
21- Distribution: https://unpkg.com/browse/@sutton-signwriting/core/
22- Documentation: https://www.sutton-signwriting.io/core/
23- Issue Tracker: https://github.com/sutton-signwriting/core/issues
24- Online Discussion: https://gitter.im/sutton-signwriting/community
25
26## Types of files
27The source is written in small ES Modules available in the `src` directory along with the associated tests.
28
29The distribution is available in three flavors. 28 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### Install tsc command line tool
50
51 sudo apt install node-typescript
52
53## Usage
54
55### Using in Node
56
57 // import entire library
58 const core = require('@sutton-signwriting/core');
59
60 // import individual module
61 const fsw = require('@sutton-signwriting/core/fsw');
62
63### Using in the Browser
64
65#### Local files
66 // import entire library
67 // available as ssw.core
68 <script src="core.js"></script>
69
70 // import individual module
71 // available as ssw.fsw
72 <script src="fsw/fsw.js"></script>
73
74#### Unpkg
75 // import entire library
76 // available as ssw.core
77 <script src="https://unpkg.com/@sutton-signwriting/core@1.6.0"></script>
78
79 // import individual module
80 // available as ssw.fsw
81 <script src="https://unpkg.com/@sutton-signwriting/core@1.6.0/fsw/fsw.js"></script>
82
83## License
84MIT
85
86## SignWriting General Interest
87- SignWriting Website: https://signwriting.org/
88- Sutton SignWriting Resources: https://www.sutton-signwriting.io/
89- Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
90- Email Discussion: https://www.signwriting.org/forums/swlist/
91- Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/