Skip to content

Latest commit

 

History

History
96 lines (69 loc) · 2.86 KB

README.md

File metadata and controls

96 lines (69 loc) · 2.86 KB

Cipher Collection - All crypto algorithms you need

Build Status Coverage Status Downloads Version License We use Conventional Commits Thanks badge

Zero-dependency modular cipher collection including all well-known and often used ciphers.

🔥 Features

  • Modules per cipher to reduce size
  • Available as UMD, CJS and ES Module
  • Well tested and documented
  • Compatible with Node 8.0+
  • Zero dependencies
  • Customizable error handling

🔎 Getting started

📦️ Through NPM

$ npm install cipher-collection

ES6 import:

import { rot } from 'cipher-collection'

console.log(rot('Hello world!'))

ES5 import:

const rot = require('cipher-collection').rot

console.log(rot('Hello world!'))

🔗 Using a CDN

Using a CDN is a great way to play around with the package or reproducing issues (eg. with JSFiddle). It is not recommended using the CDN build in production, because you won't have benefits of you bundlers optimizations and you need to load the full build, no matter how many ciphers you actually use on your page.

<html>
<body>
  <pre id="t"/>
</body>
</html>
<script src="https://unpkg.com/cipher-collection/dist/cipher-collection.umd.js"></script>
<script>
document.getElementById("t").innerHTML = this["cipher-collection"].wolfenbuetteler('ABC');
</script>

🔐 Currently available ciphers

  • ROT-N (optionally with numbers)
  • Morse
  • Fractionated Morse
  • Pollux
  • Multi-Tap (optionally as exponent expression)
  • Manchester code (both standards)
  • DTMF
  • Base64 (with unicode support!)
  • Wolfenbuetteler code
  • Multiplicative cipher
  • Affine
  • AER-256
  • ARMON-64
  • Polybius

📖 Documentation

The documentation can be found here

🛠️ Contributing

Please see our CONTRIBUTING.md

📑 License

MIT License - Copyright (c) Developmint - Alexander Lichter