# xor-crypt

> Simple XOR string encryption library.

Latest version **1.1.1** (published 2018-06-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install xor-crypt
pnpm add xor-crypt
yarn add xor-crypt
bun add xor-crypt
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2018-06-11 |
| First published | 2015-02-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 0 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 10 |
| Author | Rob Loach |
| Maintainers | madeofpeople, robloach |
| Keywords | encryption |

## Links

- npm: https://www.npmjs.com/package/xor-crypt
- Repository: https://github.com/RobLoach/xor-crypt
- Issues: https://github.com/RobLoach/xor-crypt/issues
- npm.io page: https://npm.io/package/xor-crypt

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.1.1 (latest) — 2018-06-11
- 1.1.0 — 2016-07-19
- 1.0.0 — 2015-08-05
- 0.0.3 — 2015-06-17
- 0.0.2 — 2015-02-03

## README

# XOR-Crypt

[![Build Status](https://img.shields.io/travis/RobLoach/xor-crypt/gh-pages.svg)](http://travis-ci.org/RobLoach/xor-crypt "Check this project's build status on TravisCI")
[![NPM version](https://img.shields.io/npm/v/xor-crypt.svg)](https://npmjs.org/package/xor-crypt "View this project on NPM")
[![NPM downloads](https://img.shields.io/npm/dm/xor-crypt.svg)](https://npmjs.org/package/xor-crypt "View this project on NPM")
[![Dependency Status](https://img.shields.io/david/RobLoach/xor-crypt.svg)](https://david-dm.org/RobLoach/xor-crypt)
[![Dev Dependency Status](https://img.shields.io/david/dev/RobLoach/xor-crypt.svg)](https://david-dm.org/RobLoach/xor-crypt#info=devDependencies)

Simple XOR string encryption library.

## Install

### [NPM](http://npmjs.org/)
- Use: `require('xor-crypt')`
- Install: `npm install --save xor-crypt`

### [Browserify](http://browserify.org/)
- Use: `require('xor-crypt')`
- Install: `npm install --save xor-crypt`
- CDN URL: `//wzrd.in/bundle/xor-crypt@0.0.2`

### [Ender](http://ender.jit.su/)
- Use: `require('xor-crypt')`
- Install: `ender add xor-crypt`

### [Component](http://github.com/component/component)
- Use: `require('xor-crypt')`
- Install: `component install RobLoach/xor-crypt`

### [Bower](http://bower.io/)
- Use: `require('xor-crypt')`
- Install: `bower install xor-crypt`

## Usage

See the [XOR-Crypt demonstration](http://robloach.github.io/xor-crypt/) for a
live usage of XOR-Crypt.

``` javascript
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](http://npmjs.org):

    npm install

Test with [ESLint](http://eslint.org), [Mocha](http://mochajs.org) and [Mocha
JSDom](https://github.com/rstacruz/mocha-jsdom):

    npm test

Build `xor-crypt.min.js` with:

    npm run build

Tag and publish the new versions to [npm](http://npmjs.com) with [Semantic
Versioning](http://semver.org/):

    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.](https://github.com/RobLoach/xor-crypt/blob/master/HISTORY.md#files)

## License

Licensed under the incredibly [permissive](http://en.wikipedia.org/wiki/Permissive_free_software_licence) [MIT license](http://opensource.org/licenses/MIT)

---
_Source: https://npm.io/package/xor-crypt · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._