# Caesar Cipher

[![Build Statu](https://github.com/TheLe0/caesar_cipher/actions/workflows/test.yml/badge.svg)](https://github.com/TheLe0/caesar_cipher/actions/workflows/test.yml)
[![Hex Version](https://img.shields.io/hexpm/v/caesar_cipher?label=Version)](https://hex.pm/packages/caesar_cipher)
[![Downloads](https://img.shields.io/hexpm/dt/caesar_cipher?label=Downloads)](https://hex.pm/packages/caesar_cipher)

This is a package for cipher words using the classic Caesar Cipher algorithm, known as the simplest
cipher algorithm.
The algorithm is only based in changing characters by the salt specified. If you are <b>encrypting</b> the salt is going frontwards and on <b>decrypting</b> backwards.

## Installation

The package can be installed by adding `caesar_cipher` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:caesar_cipher, "~> 0.2.0"}
  ]
end
```

## Example

Using the <b>encrypt</b> function:

```bash
iex> CaesarCipher.encrypt("Hello World!", 2) 
"Jgnnq Yqtnf!"
```

Using the <b>decrypt</b> function:

```bash
iex> CaesarCipher.decrypt("Jgnnq Yqtnf!", 2) 
"Hello World!"
```