Skip to content

Commit

Permalink
docs: updated front page
Browse files Browse the repository at this point in the history
  • Loading branch information
rfdzan committed Apr 23, 2024
1 parent de5f799 commit 110d9e2
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
#![warn(missing_docs)]
//! A multi-threaded JPEG compression crate, powered by [turbojpeg](https://github.com/honzasp/rust-turbojpeg).
//! A simple, multi-threaded JPEG compression crate, powered by [turbojpeg](https://github.com/honzasp/rust-turbojpeg).
//!
//! This crate provides methods of compressing JPEG images in a single-threaded or multi-threaded way. Both methods preserves [EXIF](https://en.wikipedia.org/wiki/Exif) data of the original JPEG through [img_parts](https://docs.rs/img-parts/latest/img_parts/) crate.
//! This crate doesn't give you finer controls over how you compress your JPEGs.
//! Check out [turbojpeg](https://github.com/honzasp/rust-turbojpeg) for that.
//!
//! Provides methods of compressing JPEG images in a single-threaded or multi-threaded way. Both methods preserves [EXIF](https://en.wikipedia.org/wiki/Exif) data of the original JPEG through [img_parts](https://docs.rs/img-parts/latest/img_parts/) crate.
//!
//! [`Single`] is meant for single image compressions.
//! [`Parallel`] is meant for bulk compressions e.g. compressing a list of image bytes.
//! [`Parallel`] is meant for bulk compressions e.g. compressing a vector of image bytes.
//!
//! As the name implies, [`Single`] is single-threaded whereas [`Parallel`] is multi-threaded.
//! # Error building `turbojpeg`?
Expand Down

0 comments on commit 110d9e2

Please sign in to comment.