11
11
12
12
> Zero-dependency modular cipher collection including all well-known and often used ciphers.
13
13
14
- ## Features
14
+ ## 🔥 Features
15
15
16
16
- Modules per cipher to reduce size
17
17
- Available as UMD, CJS and ES Module
18
18
- Well tested and [ documented] ( ./docs/index.md )
19
+ - Compatible with Node 8.0+
19
20
- Zero dependencies
20
21
- Customizable error handling
21
22
22
- ## Getting started
23
+ ## 🔎 Getting started
23
24
24
25
25
- ### Through NPM
26
+ ### 📦️ Through NPM
27
+
26
28
```
27
29
$ npm install cipher-collection
28
30
```
@@ -42,15 +44,34 @@ const rot = require('cipher-collection').rot
42
44
console.log(rot('Hello world!'))
43
45
```
44
46
47
+ ### 🔗 Using a CDN
48
+
49
+ Using a CDN is a great way to play around with the package or reproducing issues (eg. with JSFiddle).
50
+ It is ** not recommended** using the CDN build in production, because you won't have benefits of you bundlers optimizations
51
+ and you need to load the full build, no matter how many ciphers you actually use on your page.
52
+
53
+
54
+ ``` html
55
+ <html >
56
+ <body >
57
+ <pre id =" t" />
58
+ </body >
59
+ </html >
60
+ <script src =" https://unpkg.com/cipher-collection/dist/cipher-collection.umd.js" ></script >
61
+ <script >
62
+ document .getElementById (" t" ).innerHTML = this [" cipher-collection" ].wolfenbuetteler (' ABC' );
63
+ </script >
64
+ ```
65
+
45
66
46
- ## Currently available ciphers
67
+ ## 🔐 Currently available ciphers
47
68
48
- - ROT-N (custom number of rotations, optional number rotation )
49
- - Morse (custom delimiter, custom handling of unknown characters)
69
+ - ROT-N (optionally with numbers )
70
+ - Morse
50
71
- Fractionated Morse
51
72
- Pollux
52
- - Multi-Tap
53
- - Manchester code
73
+ - Multi-Tap (optionally as exponent expression)
74
+ - Manchester code (both standards)
54
75
- DTMF
55
76
- Base64 (with unicode support!)
56
77
- Wolfenbuetteler code
@@ -59,7 +80,11 @@ console.log(rot('Hello world!'))
59
80
- AER-256
60
81
- ARMON-64
61
82
62
- ## Contributing
83
+ ## 📖 Documentation
84
+
85
+ The documentation can be found [ here] ( ./docs/index.md )
86
+
87
+ ## 🛠️ Contributing
63
88
64
89
Please see our [ CONTRIBUTING.md] ( ./CONTRIBUTING.md )
65
90
0 commit comments