BIMED

A binary image encoder/decoder
Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Built With

• sharp
• yargs
• typescript

Getting Started

Installation

1. Install NPM package

   npm install bimed

Usage

You can use this package as a CLI tool: simply type bimed --help into your terminal to get started.

You can also include the package into your project and use the exported methods:

const { encode, decode } = require("bimed").default;
// or
import { encode, decode } from "bimed";

const encoded = encode("1111000011000011", {
	width: 4,
	scale: 2,
	inverted: true,
});
const decoded = decode(encoded, { width: 4, scale: 2, inverted: true });
console.log(decoded); // "1111000011000011"

Note 1: getting the encoded data using the CLI tool is not supported at this time. If you want to manipulate the raw encoded RGB bytes, use the exported methods in your project.

Note 2: saving the encoded data to an image file is only possible using the CLI tool. If you want to manipulate the raw encoded RGB bytes before saving them to a file, use the exported methods in your project and then save the data to a file (must use raw encoding i.e. saving the raw bytes which represent pixel RGB data).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Leo Petrovic - leopetrovic11@gmail.com

Project Link: https://github.com/mapokapo/bimed