Skip to content

Commit b7b71fb

Browse files
docs(readme): Emojify, add CDN info and polishing
1 parent 0280261 commit b7b71fb

File tree

1 file changed

+34
-9
lines changed

1 file changed

+34
-9
lines changed

README.md

Lines changed: 34 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,18 +11,20 @@
1111

1212
> Zero-dependency modular cipher collection including all well-known and often used ciphers.
1313
14-
## Features
14+
## 🔥 Features
1515

1616
- Modules per cipher to reduce size
1717
- Available as UMD, CJS and ES Module
1818
- Well tested and [documented](./docs/index.md)
19+
- Compatible with Node 8.0+
1920
- Zero dependencies
2021
- Customizable error handling
2122

22-
## Getting started
23+
## 🔎 Getting started
2324

2425

25-
### Through NPM
26+
### 📦️ Through NPM
27+
2628
```
2729
$ npm install cipher-collection
2830
```
@@ -42,15 +44,34 @@ const rot = require('cipher-collection').rot
4244
console.log(rot('Hello world!'))
4345
```
4446

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+
4566

46-
## Currently available ciphers
67+
## 🔐 Currently available ciphers
4768

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
5071
- Fractionated Morse
5172
- Pollux
52-
- Multi-Tap
53-
- Manchester code
73+
- Multi-Tap (optionally as exponent expression)
74+
- Manchester code (both standards)
5475
- DTMF
5576
- Base64 (with unicode support!)
5677
- Wolfenbuetteler code
@@ -59,7 +80,11 @@ console.log(rot('Hello world!'))
5980
- AER-256
6081
- ARMON-64
6182

62-
## Contributing
83+
## 📖 Documentation
84+
85+
The documentation can be found [here](./docs/index.md)
86+
87+
## 🛠️ Contributing
6388

6489
Please see our [CONTRIBUTING.md](./CONTRIBUTING.md)
6590

0 commit comments

Comments
 (0)