From c61d5808ff1f0f97f149b710df24e5382c356087 Mon Sep 17 00:00:00 2001 From: Yegor Pelykh Date: Tue, 18 Jun 2024 13:35:30 +0300 Subject: [PATCH] docs: README update --- README.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 813aad0..b6aeb54 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ 📋 Table of contents ================= -- [📜 Overview](#📜-overview) -- [🖼️ Supported Image Formats](#🖼️-supported-image-formats) -- [🆘 Examples of using](#🆘-examples-of-using) -- [📰 Documentation](#📰-documentation) -- [🏭 Performance Warning](#🏭-performance-warning) -- [🔧 Contributing](#🔧-contributing) -- [🔗 Links](#🔗-links) +- [📜 Overview](#overview) +- [🖼️ Supported Image Formats](#supported-image-formats) +- [🆘 Examples of using](#examples-of-using) +- [📰 Documentation](#documentation) +- [🏭 Performance Warning](#performance-warning) +- [🔧 Contributing](#contributing) +- [🔗 Links](#links) -📜 Overview -======== +

📜 Overview

**image-in-browser** is an NPM package providing the ability to load, manipulate and save images of various image file formats. @@ -21,8 +20,7 @@ This library may be especially useful when you need to work with static or animated images directly in the browser code when the code is isolated from the system it's running on. -🖼️ Supported Image Formats -======================= +

🖼️ Supported Image Formats

The following formats are currently supported for encoding / decoding: @@ -47,8 +45,7 @@ The following formats are currently supported for encoding / decoding: - **CUR** -🆘 Examples of using -================= +

🆘 Examples of using

You can see examples of using this library by checking out the repository that was specifically created for publishing code examples there: @@ -56,18 +53,15 @@ You can see examples of using this library by checking out the repository that w It will be supplemented and updated over time. -📰 Documentation -============ +

📰 Documentation

To view the documentation for the package, please go to the [**Wiki**](/~https://github.com/yegor-pelykh/image-in-browser/wiki). -🏭 Performance Warning -=================== +

🏭 Performance Warning

Since this library is written entirely in Typescript and is not a native executable library, its performance will not be as fast as a the native library. -🔧 Contributing -============ +

🔧 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated. @@ -82,8 +76,7 @@ To contribute: I will be very grateful for your support. -🔗 Links -===== +

🔗 Links

Link to NPM repository: