image-in-browser/README.md

Package for encoding / decoding images, transforming images, applying filters, drawing primitives on images on the client side (no need for server Node.js)

📋 Table of Contents
====================

- [**Introduction**](#introduction)
- [**Supported Image Formats**](#supported-image-formats)
- [**Usage Examples**](#usage-examples)
- [**Documentation**](#documentation)
- [**Performance Considerations**](#performance-considerations)
- [**Contributing**](#contributing)
- [**Useful Links**](#useful-links)

<h1 id="introduction">🌟 Introduction</h1>

Welcome to **image-in-browser**! This powerful NPM package allows you to effortlessly load, manipulate, and save images in a variety of formats, all within your browser or Node.js environment—no server-side setup required!

Key Features:
- Fully compatible with both Node.js and browser environments
- Developed entirely in TypeScript, compiled to JavaScript
- No external dependencies — lightweight and efficient
- A modern ES (ECMAScript) module for seamless integration

Whether you're working with static images or animated graphics, this library is perfect for projects where you want to keep your code isolated from the underlying system.

<h1 id="supported-image-formats">🖼️ Supported Image Formats</h1>

**image-in-browser** supports a wide range of image formats for both reading and writing:

**Read / Write Formats:**
- **BMP**
- **GIF (including animated GIFs)**
- **ICO**
- **JPG**
- **PNG (including animated APNG)**
- **TGA**
- **PVR**
- **TIFF**

**Read Only Formats:**
- **PNM (PBM, PGM, PPM)**
- **PSD**
- **WEBP (including animated WEBP)**

**Write Only Format:**
- **CUR**

<h1 id="usage-examples">💡 Usage Examples</h1>

Want to see **image-in-browser** in action? Check out our dedicated repository for practical examples and code snippets:

[**image-in-browser.examples**](https://github.com/yegor-pelykh/image-in-browser.examples) (_GitHub_)

This repository will continue to grow, providing you with more examples over time.

<h1 id="documentation">📚 Documentation</h1>

For comprehensive documentation on how to use the package, please visit our [**Wiki**](https://github.com/yegor-pelykh/image-in-browser/wiki).

<h1 id="performance-considerations">⚙️ Performance Considerations</h1>

Please note that while **image-in-browser** is a versatile library, its performance may not match that of native libraries, as it is entirely written in TypeScript. Keep this in mind when planning your projects.

<h1 id="testing">🧪 Testing</h1>

The project includes a comprehensive suite of tests to ensure functionality and reliability. To run the tests, use the following command:

```bash
npm run test:all
```

This will execute all test cases defined in the project.

<h1 id="contributing">🤝 Contributing</h1>

We believe that contributions are the heart of the open-source community! Your input can help make **image-in-browser** even better.

To contribute:
1. Fork the project
2. Create your feature branch (e.g., `git checkout -b feature/AmazingFeature`)
3. **Important!** Run `npm run build` to ensure your code meets project standards
4. **Important!** Address any errors or warnings that arise from your changes
5. Commit your changes (e.g., `git commit -m 'Add some AmazingFeature'`)
6. Push to your branch (e.g., `git push origin feature/AmazingFeature`)
7. Open a Pull Request

Your support is greatly appreciated!

<h1 id="license">📜 License</h1>

This project is licensed under the MIT License. See the [**LICENSE.md**](/LICENSE.md) file for details.

<h1 id="useful-links">🔗 Useful Links</h1>

Check out our NPM repository for more information:

<a href="https://nodei.co/npm/image-in-browser/"><img src="https://nodei.co/npm/image-in-browser.png"></a>