Skip to content

Commit

Permalink
Readme template appended
Browse files Browse the repository at this point in the history
  • Loading branch information
@darsan-in
darsan-in committed Aug 12, 2024
1 parent 4090845 commit de17ba8
Showing 1 changed file with 285 additions and 93 deletions.
378 changes: 285 additions & 93 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,93 +1,285 @@
**Minomax - Comprehensive Web Resource Compressor for Node.js**

Minomax is a powerful Node.js package designed to efficiently compress a wide range of web resources, including videos, images, HTML, CSS, JavaScript, and SVG files. Enhance your website's performance and reduce load times with Minomax's robust compression capabilities.

### Key Features:

- **Video Compression**: Optimize video files for faster streaming and reduced bandwidth usage.
- **Image Compression**: Compress images without compromising quality, supporting formats like JPEG, PNG, GIF, and more.
- **HTML Minification**: Reduce the size of your HTML files for quicker page loads.
- **CSS Minification**: Minimize your CSS files to improve site speed and performance.
- **JavaScript Minification**: Shrink your JS files to accelerate page rendering.
- **SVG Compression**: Compress SVG files while maintaining their visual integrity.
- **Generate Dynamic imageSets**: Collections of images that adapt to various screen sizes, resolutions, or device types to reduce network overhead.

### Benefits:

- Boost website performance
- Decrease load times
- Reduce bandwidth usage
- Improve SEO rankings

## Compression Results

### Image Compression

- **Original Size**: 43.9 MB
- **Compressed Size**: 1.44 MB
- **Compression Ratio**: 96.72%

![Image Compression](https://github.com/cresteem/Minomax-Demo/blob/main/reports/image_compression.png?raw=true)

### Video Compression

- **Original Size**: 15.2 MB
- **Compressed Size**: 1.04 MB
- **Compression Ratio**: 93.16%

![Video Compression](https://github.com/cresteem/Minomax-Demo/blob/main/reports/video_compression.png?raw=true)

### Web Document Compression

- **Original Size**: 175 KB
- **Compressed Size**: 131 KB
- **Compression Ratio**: 25.14%

![Web Document Compression](https://github.com/cresteem/Minomax-Demo/blob/main/reports/webdoc_compression.png?raw=true)


### Installation:

#### NPM

```bash
npm install --dev @cresteem/minomax
```

#### YARN

```bash
yarn add -D @cresteem/minomax
```

Available on NPM:

![NPM Version](https://img.shields.io/npm/v/%40cresteem%2Fminomax?style=flat&logo=rocket&logoColor=black&logoSize=auto&label=Minomax%20Version&labelColor=white)


![NPM Downloads](https://img.shields.io/npm/d18m/%40cresteem%2Fminomax?style=flat&logo=rocket&logoColor=black&logoSize=auto&label=Download%20Counts&labelColor=white&color=rgb(80,200,10))


## 🧑🏻 Maintainer
[@iamspdarsan](https://github.com/iamspdarsan) - [LinkedIN](https://in.linkedin.com/in/iamspdarsan) - [Github](https://github.com/iamspdarsan)

## ⚖️ License

Minomax © 2024 by 🚀[CRESTEEM](https://www.cresteem.com/) is licensed under [APACHE LICENSE VERSION 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt)

## 💁🏻 Contribution

By contributing to this project, you agree that your contributions will be licensed under the Apache License, Version 2.0. You can find the full text of the license in the LICENSE file located in the root directory of this project.

For more about contribution check [CONTRIBUTING](./CONTRIBUTING) file.

### ©️ Attribution Requirements

In addition to the terms of the Apache License, Version 2.0, you are required to provide the following attribution in any use, reproduction, and distribution of this software:

"This software includes Minomax © 2024 by [CRESTEEM](https://www.cresteem.com/). Licensed under the Apache License, Version 2.0."

This attribution must be displayed in a prominent location in any documentation, notices, or marketing materials accompanying the distribution or use of this software.

## 🌐 Documenation Website
https://minomax.cresteem.com/
<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

[![Android](https://img.shields.io/badge/Android-3DDC84?style=for-the-badge&logo=android&logoColor=white)]()
[![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge&logo=linux&logoColor=black)]()
[![Windows](https://img.shields.io/badge/Windows-0078D6?style=for-the-badge&logo=windows&logoColor=white)]()
[![Node JS](https://img.shields.io/badge/Node.js-43853D?style=for-the-badge&logo=node.js&logoColor=white)]()
[![Python](https://img.shields.io/badge/Python-3776AB?style=for-the-badge&logo=python&logoColor=white)]()
[![Java](https://img.shields.io/badge/Java-ED8B00?style=for-the-badge&logo=openjdk&logoColor=white)]()

---

[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 connect@cresteem.com

## Credits 🙏🏻

[credits to lib maintainers/creators]

---

<p align="center">
<a href="https://cresteem.com/">
<img src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/branding-gh.png" alt="Cresteem Logo">
</a>
</p>

<p align="center">

<span>
<a href="https://www.instagram.com/cresteem/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/insta.png" alt="Cresteem at Instagram"></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.linkedin.com/company/cresteem/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/linkedin.png" alt="Cresteem 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://x.com/cresteem"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/x.png" alt="Cresteem at Twitter / X"></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/@Cresteem"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/youtube.png" alt="Cresteem 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://github.com/cresteem"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/github.png" alt="Cresteem 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/cresteem"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/hf.png" alt="Cresteem 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://cresteem.com/"><img width='45px' height='45px' src="https://raw.githubusercontent.com/darsan-in/.github/main/brand/footer-icons/website.png" alt="Cresteem Website"></a>
</span>

</p>

---

#### Topics

<ul id="keywords">

<li>A</li>
<li>B</li>
<li>C</li>
<li>D</li>

</ul>

0 comments on commit de17ba8

Please sign in to comment.