Rename PM_Dictionary_Validator to Dictionary_Validatoristanbul

Signed-off-by: Bartosz Gardziejewski <bartosz.gardziejewski@nokia.com>
Change-Id: Icb65e6f832804aa4a958e530422d35e079ffe3c1
Issue-ID: VNFSDK-769

1 files changed, 26 insertions, 0 deletions

diff --git a/dictionaryvalidation/README.md b/dictionaryvalidation/README.md
new file mode 100644
index 0000000..4e1a6f5
--- /dev/null
+++ b/dictionaryvalidation/README.md
@@ -0,0 +1,26 @@
+Dictionary Validation
+=======================
+This module can be used as a library to validate dictionary against the schema (schema is the first document in the file).
+
+How to use Dictionary validation library
+------------------------------------------
+VNF-SDK validation library (dictionaryvalidation) should be used to validate the Dictionary file.
+    Below dependency should be added to the required modules in your project.
+
+        <dependency>
+            <groupId>org.onap.vnfsdk.validation</groupId>
+            <artifactId>validation-dictionary</artifactId>
+            <version>version</version>
+        </dependency>
+
+How to validate Dictionary
+--------------------------
+1.Validate Dictionary from a path to the file.
+
+    new YamlContentValidator().validate(pathToFile)
+
+2.Validate Dictionary file from the byte array.
+
+    new YamlContentValidator().validate(fileContentAsByteArray)
+
+Above methods return list of YamlDocumentValidationError(empty list for no errors) or throw YamlProcessingException/YAMLException when something goes wrong.