# `xor-cipher`

[![License][License Badge]][License]
[![Version][Version Badge]][Crate]
[![Downloads][Downloads Badge]][Crate]
[![Test][Test Badge]][Actions]

> *Simple, reusable and optimized XOR ciphers in Rust.*

## Installation

### `cargo`

You can add `xor-cipher` as a dependency with the following command:

```console
$ cargo add xor-cipher
```

Or by directly specifying it in the configuration like so:

```toml
[dependencies]
xor-cipher = "4.0.0"
```

Alternatively, you can add it directly from the source:

```toml
[dependencies.xor-cipher]
git = "https://github.com/xor-cipher/xor-cipher-crate.git"
```

## Documentation

You can find the documentation [here][Documentation].

## Support

If you need support with the library, you can send an [email][Email].

## Changelog

You can find the changelog [here][Changelog].

## Security Policy

You can find the Security Policy of `xor-cipher` [here][Security].

## Contributing

If you are interested in contributing to `xor-cipher`, make sure to take a look at the
[Contributing Guide][Contributing Guide], as well as the [Code of Conduct][Code of Conduct].

## License

`xor-cipher` is licensed under the MIT License terms. See [License][License] for details.

[Email]: mailto:support@xor-cipher.org

[Actions]: https://github.com/xor-cipher/xor-cipher-crate/actions

[Changelog]: https://github.com/xor-cipher/xor-cipher-crate/blob/main/CHANGELOG.md
[Code of Conduct]: https://github.com/xor-cipher/xor-cipher-crate/blob/main/CODE_OF_CONDUCT.md
[Contributing Guide]: https://github.com/xor-cipher/xor-cipher-crate/blob/main/CONTRIBUTING.md
[Security]: https://github.com/xor-cipher/xor-cipher-crate/blob/main/SECURITY.md

[License]: https://github.com/xor-cipher/xor-cipher-crate/blob/main/LICENSE

[Crate]: https://crates.io/crates/xor-cipher
[Documentation]: https://docs.rs/xor-cipher

[License Badge]: https://img.shields.io/crates/l/xor-cipher
[Version Badge]: https://img.shields.io/crates/v/xor-cipher
[Downloads Badge]: https://img.shields.io/crates/dr/xor-cipher
[Test Badge]: https://github.com/xor-cipher/xor-cipher-crate/workflows/test/badge.svg