diff --git a/NOTICE b/NOTICE index d694382..067f761 100644 --- a/NOTICE +++ b/NOTICE @@ -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/ +
[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.] +
+ +### 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 + + + + + +--- + + + +
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+