-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
287 additions
and
102 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,287 @@ | ||
| ## Description | ||
|
|
||
| Remige is a forked version of libSquoosh, integrating Squoosh's image codecs directly into your JavaScript applications. This fork ensures continued support and enhancements, compatible with the latest Node.js versions for optimal performance in modern development environments. | ||
|
|
||
| ### Compatibility | ||
|
|
||
| Remige supports the latest Node.js versions, ensuring compatibility and optimal performance in modern development environments. | ||
|
|
||
| ### Why Forked? | ||
|
|
||
| With ongoing updates and improvements, Remige serves developers seeking robust image compression solutions within their JavaScript projects. It maintains functionality and reliability for current development practices. | ||
|
|
||
| ## Installation | ||
|
|
||
| Install Remige in your local project with: | ||
|
|
||
| ```bash | ||
| $ npm install remige | ||
| ``` | ||
|
|
||
| To use Remige, import `ImagePool` and set up your image processing pipeline: | ||
|
|
||
| ```javascript | ||
| import { ImagePool } from "remige"; | ||
| import { cpus } from "os"; | ||
|
|
||
| const imagePool = new ImagePool(cpus().length); | ||
| ``` | ||
|
|
||
| Ensure to only create one `ImagePool` instance to avoid memory issues during parallel image processing. | ||
|
|
||
| ## Ingesting Images | ||
|
|
||
| Ingest images using `imagePool.ingestImage()`, accepting `ArrayBuffer` from `fs.readFile()` or `fetch()`. | ||
|
|
||
| ```javascript | ||
| import fs from "fs/promises"; | ||
|
|
||
| const file = await fs.readFile("./path/to/image.png"); | ||
| const image = imagePool.ingestImage(file); | ||
| ``` | ||
|
|
||
| ## Preprocessing and Encoding Images | ||
|
|
||
| Preprocess and encode images to various formats: | ||
|
|
||
| ```javascript | ||
| const preprocessOptions = { | ||
| resize: { | ||
| width: 100, | ||
| height: 50, | ||
| }, | ||
| }; | ||
|
|
||
| await image.preprocess(preprocessOptions); | ||
|
|
||
| const encodeOptions = { | ||
| mozjpeg: {}, // default settings | ||
| jxl: { | ||
| quality: 90, | ||
| }, | ||
| }; | ||
|
|
||
| const result = await image.encode(encodeOptions); | ||
| ``` | ||
|
|
||
| ## Closing ImagePool | ||
|
|
||
| Close the `ImagePool` pipeline to prevent ingesting and encoding new images: | ||
|
|
||
| ```javascript | ||
| await imagePool.close(); | ||
| ``` | ||
|
|
||
| ## Writing Encoded Images to File System | ||
|
|
||
| Write encoded images to the file system: | ||
|
|
||
| ```javascript | ||
| const rawEncodedImage = image.encodedWith.mozjpeg.binary; | ||
|
|
||
| await fs.writeFile("/path/to/new/image.jpg", rawEncodedImage); | ||
| ``` | ||
|
|
||
| ## Extracting Image Information | ||
|
|
||
| Extract decoded and encoded image information: | ||
|
|
||
| ```javascript | ||
| console.log(await image.decoded); | ||
| console.log(image.encodedWith.jxl); | ||
| ``` | ||
|
|
||
| ## Auto Optimizer | ||
|
|
||
| Remige includes an experimental auto optimizer: | ||
|
|
||
| ```javascript | ||
| const encodeOptions = { | ||
| mozjpeg: "auto", | ||
| }; | ||
| ``` | ||
| <div align="center"> | ||
|
|
||
| # [Title] - [short desc] | ||
|
|
||
| <p id="intro">[This is a placeholder paragraph. Here some introductory text or describe the content that will eventually go in this section. This text is meant to give a sense of how the final content will look in the design.] | ||
| </p> | ||
|
|
||
| ### Supported Platforms | ||
|
|
||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
| []() | ||
|
|
||
| --- | ||
|
|
||
| [uname-holder/reponame-holder] [npm-name-holder] [wf-holder] - for test&build | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/uname-holder/reponame-holder/commits/main"> | ||
| <img src="https://img.shields.io/github/last-commit/uname-holder/reponame-holder?display_timestamp=committer&style=for-the-badge&label=Updated%20On" alt="GitHub last commit"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href=""> | ||
| <img src="https://img.shields.io/github/commit-activity/m/uname-holder/reponame-holder?style=for-the-badge&label=Commit%20Activity" alt="GitHub commit activity"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/uname-holder/reponame-holder/actions/workflows/wf-holder.yml"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/uname-holder/reponame-holder/wf-holder.yml?style=for-the-badge&label=Build%20Status" alt="GitHub Actions Build Status"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/uname-holder/reponame-holder/actions/workflows/wf-holder.yml"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/uname-holder/reponame-holder/wf-holder.yml?style=for-the-badge&label=Test%20Status" alt="GitHub Actions Test Status"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href="LICENSE"> | ||
| <img src="https://img.shields.io/github/license/uname-holder/reponame-holder?style=for-the-badge&label=License" alt="GitHub License"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/uname-holder/reponame-holder/releases"> | ||
| <img src="https://img.shields.io/github/v/release/uname-holder/reponame-holder?include_prereleases&sort=date&display_name=tag&style=for-the-badge&label=Latest%20Version" alt="GitHub Release"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href="https://www.codefactor.io/repository/github/uname-holder/reponame-holder/issues/main"> | ||
| <img src="https://img.shields.io/codefactor/grade/github/uname-holder/reponame-holder?style=for-the-badge&label=Code%20Quality%20Grade" alt="CodeFactor Grade"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href=""> | ||
| <img src="https://img.shields.io/npm/d18m/npm-name-holder?style=for-the-badge&label=Downloads%20On%20NPM" alt="NPM Downloads"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href=""> | ||
| <img src="https://img.shields.io/github/stars/uname-holder/reponame-holder?style=for-the-badge&label=Stars" alt="GitHub Repo stars"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| <p> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/sponsors/darsan-in"> | ||
| <img src="https://img.shields.io/github/sponsors/darsan-in?style=for-the-badge&label=Generous%20Sponsors" alt="GitHub Sponsors"/> | ||
| </a> | ||
| </span> | ||
|
|
||
| </p> | ||
|
|
||
| --- | ||
|
|
||
| </div> | ||
|
|
||
| ## Table of Contents 📝 | ||
|
|
||
| - [Features and Benefits](#features-and-benefits-) | ||
| - [Use Cases](#use-cases-) | ||
| - [Friendly request to users](#-friendly-request-to-users) | ||
|
|
||
| - [Installation - Step-by-Step Guide](#installation---step-by-step-guide-) | ||
| - [Usage](#usage) | ||
| - [In-Action](#in-action-) | ||
|
|
||
| - [License](#license-%EF%B8%8F) | ||
| - [Contributing to Our Project](#contributing-to-our-project-) | ||
| - [Website](#website-) | ||
|
|
||
| - [Contact Information](#contact-information) | ||
| - [Credits](#credits-) | ||
|
|
||
| ## Features and Benefits ✨ | ||
|
|
||
| - [f1] | ||
| - [f2] | ||
| - [fn] | ||
|
|
||
| ## Use Cases ✅ | ||
|
|
||
| - [usecase 1] | ||
| - [use case 2] | ||
|
|
||
| --- | ||
|
|
||
| ### 🙏🏻 Friendly Request to Users | ||
|
|
||
| Every star on this repository is a sign of encouragement, a vote of confidence, and a reminder that our work is making a difference. If this project has brought value to you, even in the smallest way, **please consider showing your support by giving it a star.** ⭐ | ||
|
|
||
| _"Star" button located at the top-right of the page, near the repository name._ | ||
|
|
||
| Your star isn’t just a digital icon—it’s a beacon that tells us we're on the right path, that our efforts are appreciated, and that this work matters. It fuels our passion and drives us to keep improving, building, and sharing. | ||
|
|
||
| If you believe in what we’re doing, **please share this project with others who might find it helpful.** Together, we can create something truly meaningful. | ||
|
|
||
| Thank you for being part of this journey. Your support means the world to us. 🌍💖 | ||
|
|
||
| --- | ||
|
|
||
| ## Installation - Step-by-Step Guide 🪜 | ||
|
|
||
| [Installation instructions here] | ||
|
|
||
| - **Step 1:** | ||
| - **Step 2:** | ||
| - **Step 3:** | ||
| - **Step 4:** | ||
| - **Step 5:** | ||
|
|
||
| ## Usage | ||
|
|
||
| - [purpose heading] | ||
| [Demonstration here] | ||
|
|
||
| ```bash | ||
| demo | ||
| ``` | ||
|
|
||
| ## In-Action 🤺 | ||
|
|
||
| [video] or [gif] or [image] | ||
|
|
||
| ## License ©️ | ||
|
|
||
| This project is licensed under the [Apache License 2.0 or GNU General Public License v3.0 or MIT](LICENSE). | ||
|
|
||
| ## Contributing to Our Project 🤝 | ||
|
|
||
| We’re always open to contributions and fixing issues—your help makes this project better for everyone. | ||
|
|
||
| If you encounter any errors or issues, please don’t hesitate to [raise an issue](../../issues/new). This ensures we can address problems quickly and improve the project. | ||
|
|
||
| For those who want to contribute, we kindly ask you to review our [Contribution Guidelines](CONTRIBUTING) before getting started. This helps ensure that all contributions align with the project's direction and comply with our existing [license](LICENSE). | ||
|
|
||
| We deeply appreciate everyone who contributes or raises issues—your efforts are crucial to building a stronger community. Together, we can create something truly impactful. | ||
|
|
||
| Thank you for being part of this journey! | ||
|
|
||
| ## Website 🌐 | ||
|
|
||
| <a id="url" href="https://darsan.in">[https://darsan.in]</a> | ||
|
|
||
| ## Contact Information | ||
|
|
||
| For any questions, please reach out via hello@darsan.in or [LinkedIn](https://www.linkedin.com/in/darsan-in/). | ||
|
|
||
| ## Credits 🙏🏻 | ||
|
|
||
| [credits to lib maintainers/creators] | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"> | ||
|
|
||
| <span> | ||
| <a href="https://www.linkedin.com/in/darsan-in/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/linkedin.png" alt="Darsan at Linkedin"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://www.youtube.com/@darsan-in"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/youtube.png" alt="Darsan at Youtube"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://www.facebook.com/darsan.in/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/facebook.png" alt="Darsan at Facebook"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://www.npmjs.com/~darsan.in"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/npm.png" alt="Darsan at NPM"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://github.com/darsan-in"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/github.png" alt="Darsan at Github"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://huggingface.co/darsan"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/hf.png" alt="Darsan at Huggingface"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://www.reddit.com/user/iamspdarsan/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/reddit.png" alt="Darsan at Reddit"></a> | ||
| </span> | ||
|
|
||
| <span> | ||
| <img width='20px' height='20px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/gap.png" alt="place holder image"> | ||
| </span> | ||
|
|
||
| <span> | ||
| <a href="https://darsan.in/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/website.png" alt="Darsan Website"></a> | ||
| </span> | ||
|
|
||
| <p> | ||
|
|
||
| --- | ||
|
|
||
| #### Topics | ||
|
|
||
| <ul id="keywords"> | ||
|
|
||
| <li>A</li> | ||
| <li>B</li> | ||
| <li>C</li> | ||
| <li>D</li> | ||
|
|
||
| </ul> |