Skip to content

Commit

Permalink
docs: README update
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor-pelykh committed Jun 18, 2024
1 parent 3c00e37 commit c61d580
Showing 1 changed file with 14 additions and 21 deletions.
35 changes: 14 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
========
<h1 id="overview">📜 Overview</h1>

**image-in-browser** is an NPM package providing the ability to load, manipulate and save images of various image file formats.

Expand All @@ -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
=======================
<h1 id="supported-image-formats">🖼️ Supported Image Formats</h1>

The following formats are currently supported for encoding / decoding:

Expand All @@ -47,27 +45,23 @@ The following formats are currently supported for encoding / decoding:

- **CUR**

🆘 Examples of using
=================
<h1 id="examples-of-using">🆘 Examples of using</h1>

You can see examples of using this library by checking out the repository that was specifically created for publishing code examples there:

[**image-in-browser.examples**](/~https://github.com/yegor-pelykh/image-in-browser.examples) (_GitHub_)

It will be supplemented and updated over time.

📰 Documentation
============
<h1 id="documentation">📰 Documentation</h1>

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

🏭 Performance Warning
===================
<h1 id="performance-warning">🏭 Performance Warning</h1>

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
============
<h1 id="contributing">🔧 Contributing</h1>

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Expand All @@ -82,8 +76,7 @@ To contribute:

I will be very grateful for your support.

🔗 Links
=====
<h1 id="links">🔗 Links</h1>

Link to NPM repository:

Expand Down

0 comments on commit c61d580

Please sign in to comment.