chore: add markdown lint

Author: LabEG

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+    "default": true,
+    "MD013": {
+        "line_length": 120
+    }
+}

.markdownlintignore

@@ -0,0 +1 @@
+CHANGELOG.md

CHANGELOG.md

@@ -4,13 +4,11 @@ All notable changes to this project will be documented in this file. See [standa
 
 ## 1.4.0 (2022-12-30)
 
-
 ### Features
 
     * throw error 400 on image download error ([f9af9c0](https://github.com/MobileTeleSystems/image-optimize/commit/f9af9c04879573dbbf1301e1323ddc7d2059ddd8))
     * update packages versions ([11e314e](https://github.com/MobileTeleSystems/image-optimize/commit/11e314ec7a68b3981a37399b621cabac26333a90))
 
-
 ### Bug Fixes
 
-  * throw error 404 if image src return 404 ([dc4bf2a](https://github.com/MobileTeleSystems/image-optimize/commit/dc4bf2aea308f88a18b8427004ff0281e55ce0c5))
+* throw error 404 if image src return 404 ([dc4bf2a](https://github.com/MobileTeleSystems/image-optimize/commit/dc4bf2aea308f88a18b8427004ff0281e55ce0c5))

CODE_OF_CONDUCT.md

@@ -27,8 +27,8 @@ community include:
 
 Examples of unacceptable behavior include:
 
-    * The use of sexualized language or imagery, and sexual attention or advances of
-      any kind
+    * The use of sexualized language or imagery, and sexual attention or advances
+      of any kind
     * Trolling, insulting or derogatory comments, and personal or political attacks
     * Public or private harassment
     * Publishing others' private information, such as a physical or email address,

README.md

@@ -1,12 +1,12 @@
+# Microservice for responsive resize, compression and optimization of images on the fly for web pages
+
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/042786e7f0304d1ea29d83f8c1522a55)](https://www.codacy.com/gh/MobileTeleSystems/image-optimize/dashboard?utm_source=github.com&utm_medium=referral&utm_content=MobileTeleSystems/image-optimize&utm_campaign=Badge_Grade)
-[![npm version](https://img.shields.io/npm/v/react.svg?style=flat)](https://www.npmjs.com/package/@mts-pjsc/image-optimize
-)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
 [![GitHub license](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/MobileTeleSystems/image-optimize/blob/main/LICENSE)
 
-# Microservice for responsive resize, compression and optimization of images on the fly for web pages.
-
-Optimizing images helps reduce image weight and increases website loading speed, which is very important for both users and search engines. For these purposes, we have created a microservice that perfectly copes with this task.
+Optimizing images helps reduce image weight and increases website loading speed,
+which is very important for both users and search engines. For these purposes,
+we have created a microservice that perfectly copes with this task.
 
 Features:
     - Resize images for the user's screen size,
@@ -18,32 +18,49 @@ Features:
     - Supports basic authorization for multiple domains and endpoints,
     - Supports security restrictions for allowed addresses.
 
-### Try
+## Try
+
 To try the microservice features, run the container with the command:
+
 ```sh
 docker run -it --rm -p 3000:3000 mtsrus/image-optimize
 ```
 
 Now you can open the browser and check the work with the command:
+
 ```sh
 http://localhost:3000/optimize?size=1060&format=webp&src=https://tb.mts.ru/static/landing/images-index2/banner/slider/partners.png
 ```
 
-By changing the src, size, format parameters, you can choose the path to the image, the final size and the image format.
+By changing the src, size, format parameters,
+you can choose the path to the image,
+the final size and the image format.
 
 ### Use
+
 To start the microservice in production, use the command:
+
 ```sh
 docker run -d --restart always -p 3000:3000 mtsrus/image-optimize
 ```
 
 ### Container parameters
 
-    - `-e PORT=3000` - the port on which the microservice will be launched, default 3000.
-    - `-e ALLOW_SIZES="100,200,1024-1920"` - an array of allowed sizes for the resulting images, default 100-1920. Use specific values to prevent heavy loads on the server.
-    - `-e ALLOW_SOURCES="https%3A%2F%2Ftb.mts.ru%2F"` - url array of allowed addresses for image sources, default * (any). Use comma as separator. It is recommended to apply encodeURIComponent to url.
-    - `-e BASIC_AUTHS="https%3A%2F%2Ftb.mts.ru%2F"` - an array of endpoints with basic authorization parameters, default empty. Has format encodeURIComponent("url"):encodeURIComponent("login"):encodeURIComponent("password"). Use comma as separator.
-    - `-e SHARP_CONCURRENCY=0` - number of threads libvips' should create to process each image, default 0 (will reset to the number of CPU cores).
+- `-e PORT=3000` - the port on which the microservice will be launched, default 3000.
+- `-e ALLOW_SIZES="100,200,1024-1920"` - an array of allowed sizes for the resulting images,
+    default 100-1920. Use specific values to prevent heavy loads on the server.
+
+- `-e ALLOW_SOURCES="https%3A%2F%2Ftb.mts.ru%2F"` - url array of allowed addresses for image sources, default * (any).
+    Use comma as separator. It is recommended to apply encodeURIComponent to url.
+
+- `-e BASIC_AUTHS="https%3A%2F%2Ftb.mts.ru%2F"` - an array of endpoints with basic authorization parameters, default empty.
+    Has format encodeURIComponent("url"):encodeURIComponent("login"):encodeURIComponent("password"). Use comma as separator.
+
+- `-e SHARP_CONCURRENCY=0` - number of threads libvips' should create to process each image,
+    default 0 (will reset to the number of CPU cores).
 
 ### Components for web
-To optimize images in the browser, there is a component for React. You can find it [by following the link](https://github.com/MobileTeleSystems/image-optimize-react). The component itself determines the most suitable image parameters and requests it from this microservice.
+
+To optimize images in the browser, there is a component for React. You can find it
+[by following the link](https://github.com/MobileTeleSystems/image-optimize-react).
+The component itself determines the most suitable image parameters and requests it from this microservice.