Skip to content

Commit

Permalink
Add good practices to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
krzysztofreczek authored Nov 19, 2020
1 parent eaf822b commit cd283c2
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit cd283c2

Please sign in to comment.