📄(README): update readme and versions

Author: W-Mai

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icu_tool"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Benign X", "W-Mai"]
 homepage = "https://github.com/W-Mai/icu"
@@ -14,7 +14,7 @@ name = "icu"
 path = "src/main.rs"
 
 [dependencies]
-icu_lib = { version = "0.1.0" }
+icu_lib = { version = "0.1.1" }
 clap = { version = "4.4.18", features = ["derive", "suggestions"] }
 eframe = { version = "0.26.0", features = ["glow"] }
 egui_plot = "0.26.0"

README.md

@@ -15,7 +15,21 @@ written in RUST.
 - Supports LVGL binary format
 - Supports preview a wide range of image formats and LVGL binary format
 
-# How to build
+# How to install
+
+ICU is written in RUST, so you need to have the RUST environment installed on your system.
+
+```shell
+curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
+```
+
+After that, you can install ICU by running the following command:
+
+```shell
+cargo install icu_tool
+```
+
+# How to build yourself
 
 ```shell
 cargo build --release
@@ -60,58 +74,3 @@ icu show res/img_0.bin -f lvgl-v9
 
 And you will get a window with the image like before.
 
-# How to use
-
-```rust
-use icu_lib::endecoder::{common, lvgl_v9};
-use icu_lib::midata::MiData;
-use icu_lib::EncoderParams;
-use std::fs;
-
-fn main() {
-    const DATA: &[u8] = include_bytes!("../res/img_0.png");
-
-    // Decode the image data and automatically detect the format
-    let mid = MiData::decode_from::<common::AutoDectect>(Vec::from(DATA));
-
-    // Encode the image data to the LVGL binary format with ARGB8888 color format
-    let data = mid.encode_into::<lvgl_v9::ColorFormatARGB8888>(
-        EncoderParams {
-            stride_align: 256,
-            dither: false,
-        });
-
-    fs::write("img_0.bin", data).expect("Unable to write file");
-}
-```
-
-# Architecture
-
-```text
-       ╔═══════════════╗                       
-       ║               ║                       
-       ║               ║                       
-┌ ─ ─ ─ ─ ─ ─ ┐        ║                       
-  ┌ ─ ─ ─ ─ ┐          ║                       
-│  EnDecoder  │        ▼                       
-  └ ─ ─ ─ ─ ┘   ┌ ─ ─ ─ ─ ─ ─ ┐                
-│┌───────────┐│   ┌ ─ ─ ─ ─ ┐                  
- │    PNG    │  │   MidData   │                
-│└───────────┘│   └ ─ ─ ─ ─ ┘                  
- ┌───────────┐  │┌───────────┐│                
-││   JPEG    ││  │   ARGB    │                 
- └───────────┘  │└───────────┘│ ╔-------------╗
-│┌───────────┐│  ┌───────────┐  ║   ICU_LIB   ║
- │    SVG    │  ││   PATH    ││ ╚-------------╝
-│└───────────┘│  └───────────┘                 
- ┌───────────┐  │┌── ─── ─── ┐│                
-││ LVGL BIN  ││     CUSTOM   │                 
- └───────────┘  │└── ─── ─── ┘│                
-│┌── ─── ─── ┐│  ─ ─ ─ ─ ─ ─ ─                 
-    CUSTOM   │         ║                       
-│└── ─── ─── ┘│        ║                       
- ─ ─ ─ ─ ─ ─ ─         ║                       
-       ▲               ║                       
-       ║               ║                       
-       ╚═══════════════╝                       
-```

icu_lib/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icu_lib"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 authors = ["Benign X", "W-Mai"]
 homepage = "https://github.com/W-Mai/icu"

icu_lib/README.md

@@ -0,0 +1,76 @@
+# ICU-LIB
+
+Image Converter Ultra Library (ICU-LIB)
+
+# Introduction
+
+The Image Converter Ultra (ICU) is a software that converts images from one format to another. It is designed to be a
+versatile tool that can handle a wide range of image formats and convert them to other formats. The ICU is designed to
+be a standalone application that can be used on any platform that supports the necessary dependencies. The ICU is
+written in RUST.
+
+# Features
+
+- Supports a wide range of image formats
+- Supports LVGL binary format
+- Supports preview a wide range of image formats and LVGL binary format
+
+# How to use
+
+```shell
+cargo add icu_lib
+```
+
+```rust
+use icu_lib::endecoder::{common, lvgl_v9};
+use icu_lib::midata::MiData;
+use icu_lib::EncoderParams;
+use std::fs;
+
+fn main() {
+    const DATA: &[u8] = include_bytes!("../res/img_0.png");
+
+    // Decode the image data and automatically detect the format
+    let mid = MiData::decode_from::<common::AutoDectect>(Vec::from(DATA));
+
+    // Encode the image data to the LVGL binary format with ARGB8888 color format
+    let data = mid.encode_into::<lvgl_v9::ColorFormatARGB8888>(
+        EncoderParams {
+            stride_align: 256,
+            dither: false,
+        });
+
+    fs::write("img_0.bin", data).expect("Unable to write file");
+}
+```
+
+# Architecture
+
+```text
+       ╔═══════════════╗                       
+       ║               ║                       
+       ║               ║                       
+┌ ─ ─ ─ ─ ─ ─ ┐        ║                       
+  ┌ ─ ─ ─ ─ ┐          ║                       
+│  EnDecoder  │        ▼                       
+  └ ─ ─ ─ ─ ┘   ┌ ─ ─ ─ ─ ─ ─ ┐                
+│┌───────────┐│   ┌ ─ ─ ─ ─ ┐                  
+ │    PNG    │  │   MidData   │                
+│└───────────┘│   └ ─ ─ ─ ─ ┘                  
+ ┌───────────┐  │┌───────────┐│                
+││   JPEG    ││  │   ARGB    │                 
+ └───────────┘  │└───────────┘│ ╔-------------╗
+│┌───────────┐│  ┌───────────┐  ║   ICU_LIB   ║
+ │    SVG    │  ││   PATH    ││ ╚-------------╝
+│└───────────┘│  └───────────┘                 
+ ┌───────────┐  │┌── ─── ─── ┐│                
+││ LVGL BIN  ││     CUSTOM   │                 
+ └───────────┘  │└── ─── ─── ┘│                
+│┌── ─── ─── ┐│  ─ ─ ─ ─ ─ ─ ─                 
+    CUSTOM   │         ║                       
+│└── ─── ─── ┘│        ║                       
+ ─ ─ ─ ─ ─ ─ ─         ║                       
+       ▲               ║                       
+       ║               ║                       
+       ╚═══════════════╝                       
+```