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 | @sutton-signwriting/core is a javascript package for node and browsers that supports general processing of SignWriting text.
|
8 |
|
9 | 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.
|
10 |
|
11 | ## Useful links
|
12 |
|
13 | - GitHub Repo: https://github.com/sutton-signwriting/core
|
14 | - Documentation: https://sutton-signwriting.github.io/core/
|
15 | - Issue Tracker: https://github.com/sutton-signwriting/core/issues
|
16 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
17 |
|
18 |
|
19 | ## Installation
|
20 |
|
21 | ### Install with NPM
|
22 |
|
23 | npm install @sutton-signwriting/core
|
24 |
|
25 | ### Download from GitHub
|
26 |
|
27 | https://github.com/sutton-signwriting/core/archive/master.zip
|
28 |
|
29 |
|
30 | ## Usage
|
31 |
|
32 | ### Using in Node
|
33 |
|
34 | // import entire library
|
35 | const core = require('@sutton-signwriting/core);
|
36 |
|
37 | // import individual module
|
38 | const fsw = require('@sutton-signwriting/core/fsw);
|
39 |
|
40 | ### Using in the Browser
|
41 |
|
42 | #### Local files
|
43 | // import entire library
|
44 | // available as ssw.core
|
45 | <script src="core.js"></script>
|
46 |
|
47 | // import individual module
|
48 | // available as ssw.fsw
|
49 | <script src="fsw/fsw.js"></script>
|
50 |
|
51 | #### Unpkg
|
52 | // import entire library
|
53 | // available as ssw.core
|
54 | <script src="https://unpkg.com/@sutton-signwriting/core@1.0.0"></script>
|
55 |
|
56 | // import individual module
|
57 | // available as ssw.fsw
|
58 | <script src="https://unpkg.com/@sutton-signwriting/core@1.0.0/fsw/fsw.js"></script>
|
59 |
|
60 | ## License
|
61 | MIT
|
62 |
|
63 | ## SignWriting General Interest
|
64 | - SignWriting Website: https://signwriting.org/
|
65 | - Wikipedia page: https://en.wikipedia.org/wiki/SignWriting
|
66 | - Email Discussion: https://www.signwriting.org/forums/swlist/
|
67 | - Facebook Group: https://www.facebook.com/groups/SuttonSignWriting/
|