From cd283c22ea1aaa83a2fe5f58fd2c996ca8b88b24 Mon Sep 17 00:00:00 2001 From: Krzysztof Reczek Date: Thu, 19 Nov 2020 17:00:09 +0100 Subject: [PATCH] Add good practices to README.md --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 8245ff5..3222a8f 100644 --- a/README.md +++ b/README.md @@ -91,3 +91,8 @@ defer func() { err = v.RenderTo(structure, outFile) ``` + +## Good practices +The best results and experience in using the library will be ensured by enforcing the following practices: +- Having a solid and well-organized application context following clean-architecture principles will make your diagrams simple and easy to read. Also, this will allow you to create a short list of component types and styles. +- Following consistent naming conventions will help you in creating simple and straight-forward scraper rules.