Skip to content

Latest commit

 

History

History
81 lines (50 loc) · 2.6 KB

README.md

File metadata and controls

81 lines (50 loc) · 2.6 KB
Raw

Crypi 🐍

Downloads Build status Npm Version License

A fun and simple security library for NodeJS with easy integration

Support Us 💖

If you find this project useful and want us to keep improving it, please consider:

  • Star the Repo: Give it a star on GitHub to help increase its visibility.
  • Share: Let others know about this project.

Installation 📦

To install Crypi, use npm:

npm install crypi

Usage 💻

Import the package into your project:

import { caesarCipher, caesarDecipher } from 'crypi';

Encrypt a message:

const originalText = 'Hello World!';
const encryptedText = caesarCipher(originalText);
console.log('Encrypted text:', encryptedText);

Decrypt a message:

const decryptedText = caesarDecipher(encryptedText);
console.log('Decrypted text:', decryptedText);

Documentation 📖

> Caesar Cipher:

The Caesar Cipher is a substitution cipher used in cryptography that shifts the alphabet by a fixed number of positions. It is one of the simplest and most widely known encryption techniques.

caesarCipher (text: string, shift: number = 3): string

Encrypts a message using the Caesar cipher.

  • text: The message to be encrypted.
  • shift: The number of positions to shift the alphabet. Default is 3.

caesarDecipher (text: string, shift: number = 3): string

Decrypts a message using the Caesar cipher.

  • text: The message to be decrypted.
  • shift: The number of positions to shift the alphabet. Default is 3.

Note

During encryption using the caesarCipher function, characters not part of the Latin alphabet, such as uppercase letters, accented characters, non-alphanumeric characters, or numbers, will be ignored and will retain their original form.

Contributing 🤝

Contributions are welcome! If you have a major change in mind, please open an Issue to discuss it before submitting a Pull Request.

License 📜

This project is licensed under the GNU General Public License v3.0 see the LICENSE file for details.

Contact 📧

For questions or support, please contact me at [email protected].