xor-crypt

Simple XOR string encryption library.

Usage no npm install needed!

<script type="module">
  import xorCrypt from 'https://cdn.skypack.dev/xor-crypt';
</script>

README

XOR-Crypt

Build Status NPM version NPM downloads Dependency Status Dev Dependency Status

Simple XOR string encryption library.

Install

NPM

  • Use: require('xor-crypt')
  • Install: npm install --save xor-crypt

Browserify

  • Use: require('xor-crypt')
  • Install: npm install --save xor-crypt
  • CDN URL: //wzrd.in/bundle/xor-crypt@0.0.2

Ender

  • Use: require('xor-crypt')
  • Install: ender add xor-crypt

Component

  • Use: require('xor-crypt')
  • Install: component install RobLoach/xor-crypt

Bower

  • Use: require('xor-crypt')
  • Install: bower install xor-crypt

Usage

See the XOR-Crypt demonstration for a live usage of XOR-Crypt.

var encrypted = xorCrypt('Hello World');
// Outputs: Ncjji&Qitjb

var decrypted = xorCrypt(encrypted);
// Outputs: Hello World

// Use your own XOR Key.
var encrypted = xorCrypt('Hello World', 9);
var decrypted = xorCrypt(encrypted, 9);

Development

Install dependencies through npm:

npm install

Test with ESLint, Mocha and Mocha JSDom:

npm test

Build xor-crypt.min.js with:

npm run build

Tag and publish the new versions to npm with Semantic Versioning:

git tag 2.0.0
git push origin 2.0.0
npm publish

History

Discover the change history by heading on over to the HISTORY.md file.

License

Licensed under the incredibly permissive MIT license