From ca5bec93fc620e6bb7542a2251139e815b598c00 Mon Sep 17 00:00:00 2001
From: igor <igor.markin@vereign.com>
Date: Tue, 1 Dec 2020 17:44:57 +0300
Subject: [PATCH] Add README

---
 README.md | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/README.md b/README.md
index 0c91443..2b0f35d 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,17 @@
 # Mime Normalizer
 
+Library implements normalisation of HTML and plain parts of a MIME message.
+
+Normalisation strategies documentation:
+https://code.vereign.com/light/documentation/-/blob/master/Validation.md#normalization-strategies
+
+## Testing
+
+HTML and text files with test cases provided in `__tests__/files`
+If you are going to create a new test case, please follow the structure inside this directory.
+
+- `yarn test`
+- `yarn test:watch`
+
+_Important note: MIME normaliser does not cover all provided test cases.
+Some of them explicitly ignored to indicate which tests has to be fixed. Please refer to `failingCases` arrays inside the test files._
-- 
GitLab