1 | # @sutton-signwriting/unicode8
|
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/unicode8)](https://www.npmjs.com/package/@sutton-signwriting/unicode8)
|
5 | [![npm downloads](https://img.shields.io/npm/dm/@sutton-signwriting/unicode8)](https://npm-stat.com/charts.html?package=@sutton-signwriting/unicode8&from=2020-12-06)
|
6 |
|
7 | <img alt="SignWriting in Unicode 8 (uni8) Mindmap" src="./Unicode8.jpg" width="100%">
|
8 |
|
9 | @sutton-signwriting/unicode8 is a javascript package for processing SignWriting in Unicode 8 (uni8) characters. See [SignWriting#Unicode](https://en.wikipedia.org/wiki/SignWriting#Unicode) for more information about the characters and [notofont/sign-writing](https://github.com/notofonts/sign-writing) for more information about the Unicode compliant font.
|
10 |
|
11 | This package also supports Formal SignWriting in ASCII (FSW) and SignWriting in Unicode (SWU) character sets. 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/unicode8
|
21 | - Distribution: https://unpkg.com/browse/@sutton-signwriting/unicode8/
|
22 | - Documentation: https://sutton-signwriting.github.io/unicode8/
|
23 | - Issue Tracker: https://github.com/sutton-signwriting/unicode8/issues
|
24 | - Online Discussion: https://gitter.im/sutton-signwriting/community
|
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. Minified, the whole library is 2 KB in size.
|
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/unicode8
|
39 |
|
40 | ## Developer Installation
|
41 |
|
42 | ### Download from GitHub and Install Development Dependencies
|
43 |
|
44 | wget https://github.com/sutton-signwriting/unicode8/archive/master.zip
|
45 | unzip master.zip
|
46 | cd unicode8-master
|
47 | npm install
|
48 |
|
49 | ## Usage
|
50 |
|
51 | ### Using in Node
|
52 |
|
53 | // import entire library
|
54 | const unicode8 = require('@sutton-signwriting/unicode8');
|
55 |
|
56 | // import individual module
|
57 | const unicode8Symbol = require('@sutton-signwriting/unicode8/symbol');
|
58 |
|
59 | ### Using in the Browser
|
60 |
|
61 | #### Local files
|
62 | // import entire library
|
63 | // available as ssw.unicode8
|
64 | <script src="unicode8.js"></script>
|
65 |
|
66 | // import individual module
|
67 | // available as ssw.unicode8.symbol
|
68 | <script src="symbol/symbol.js"></script>
|
69 |
|
70 | #### Unpkg
|
71 | // import entire library
|
72 | // available as ssw.unicode8
|
73 | <script src="https://unpkg.com/@sutton-signwriting/unicode8@1.1.0"></script>
|
74 |
|
75 | // import individual module
|
76 | // available as ssw.unicode8.font
|
77 | <script src="https://unpkg.com/@sutton-signwriting/unicode8@1.1.0/font/font.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/
|