Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/sefinek/rot47

Simple Node.js module for encoding and decoding text in ROT47.
https://github.com/sefinek/rot47

decoder encoder encoder-decoder npm npm-module rot47 rot47-decode rot47-encode simple-module

Last synced: 8 days ago
JSON representation

Simple Node.js module for encoding and decoding text in ROT47.

Awesome Lists containing this project

README

        

# 🌀 ROT47 - Encode and Decode
The [@sefinek/rot47](https://www.npmjs.com/package/@sefinek/rot47) module is a simple Node.js module for encoding and decoding text in ROT47.

## 📥 Installation
To install the module, use the following command:
```shell
npm install @sefinek/rot47
```

## 🤔 Usage
To use the module, require it in your [Node.js](https://nodejs.org) application:
```js
const rot47 = require('@sefinek/rot47');
```

## 🔼 Encoding text in ROT47
To encode a string in ROT47, use the `encode()` function:
```js
const encoded = rot47.encode('Hello world!');
console.log(encoded); // "w6==@ H@C=5P"
```

## 🔽 Decoding text from ROT47
To decode a string from ROT47, use the `decode()` function:
```js
const decoded = rot47.decode('w6==@ H@C=5P');
console.log(decoded); // "Hello world!"
```

## 🤝 Contributing
Contributions are always welcome! If you have any ideas or suggestions for improving this module, feel free to open an issue or submit a [pull request](https://github.com/sefinek24/rot47/pulls).

## ⭐️ Supporting the project
If you find this module useful, please consider giving it a star on [GitHub](https://github.com/sefinek24/rot47). Your support is greatly appreciated!

## 📝 License
This module is licensed under the [MIT License](LICENSE).