updated documentation

2020-11-01 12:11:28 +01:00
parent 6bbae47fae
commit cdfd6fb917
4 changed files with 4 additions and 3 deletions
--- a/.gitignore
+++ b/.gitignore
@@ -3,8 +3,6 @@
 bin/
 repos/
 /repos/
-doc/
-/doc/
 .gradle/
 /bin/
 target/
--- a/README.md
+++ b/README.md
@@ -1,10 +1,12 @@
 # Layer3gen
-Generates the standard SPRING layered CRUD architecture starting from JPA entities.
+Generates the standard SPRING 3 layer CRUD architecture starting from JPA entities.

 1) repositories
 2) services
 3) controller

+![sketch](./doc/3layer-sketch.png)
+
 ## How to run as a standalone application:
 ##### 1- Download and extract the ZIP file from the folder _/distribution_ ;
 ##### 2- Edit the file in /bin directory named _3layer-settings.yml_;
--- a/doc/3layer-sketch.drawio
+++ b/doc/3layer-sketch.drawio
@@ -0,0 +1 @@
+<mxfile host="app.diagrams.net" modified="2020-11-01T11:07:58.439Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36" etag="2rLqKXNCiuXklA1pgyvi" version="13.8.8" type="device"><diagram id="PODdKzOaVaVDoo3P5bvS" name="Page-1">7Vpbc9o4FP41PDYjW5YvjwnQlE66sJDtbvrSEbYw2hqLESJAf31lW8bXgMmaxu0suYzPkWTL5/u+oyObHuyv9vccr5efmEeCng68fQ8OerquGbrei36Bd1AeG9qJx+fUU77MMaPfiXIC5d1Sj2wKHQVjgaDrotNlYUhcUfBhztmu2G3BguJV19gnFcfMxUHV+zf1xDLx2rqV+T8Q6i/TK2umk7SscNpZ3clmiT22y7ngsAf7nDGRHK32fRJE0Uvjkox7/0LrcWKchKLJgP7Hv54s5z788qc7ctzB5y+LyeidBtXkxCG9Y+LJACiTcbFkPgtxMMy8d5xtQ49Ep9WklfV5YGytnP8SIQ4KTbwVTLqWYhWo1gULhWrUHGlvBGffjvHVox40CPosYDyeE/QwsReu9FdvWsUhmnXOoUJwT9iKCH6QHTgJsKDPRVixYod/7HccOmFUXkIHispHGBWR3xkWKJ5DYO4ToYblcSidSTPPnWnDttwllTPJg9wdZa4Y5wswR8nVnnGwVdH4OLmVjp4BhqGgIopWP8CbjdRdmRxF6HdLKshsjd2odSczQAnmEoiI2J5xhDvXYutzaJqyxY8uq0Yf9QIi4xsR7rKGPii11Rzhiwx5JlyQ/UmOpFiXAEKpY5dlAA0q3zKvfgBe5lUBxosx07ug08jOwQbiz6+hX+i0pV8I31i/hlMR8Chcb0WFIZLuoghoUXkhC0kJK+XCAfVDaboSJiL9d5F4qFwVb1XDinpezLG6FJDxDpR1XBB4qmnwAtVSdtcsdRdrWrPQeVEbNZrWryZpWIFxvBX/43gaR2g0SM4/FUfrNSXUK5Ix2VPxTxTlG6Ssp1zLYK8AiI1DaoTyDnODIvMp35YNi63DCRTrEr+75c/HBaaFVSDJnCeCbardQ5KsT6HS+rry30hivMX6nVJGyxEG3FioKWcAsAusuUGOdoY5sTUhnMq4RRnnIjp1ikHpRq4jDErnnVsuZMHeH//xOB0/PAyns3Zr9TTQlVrddG0yX3SmVjc0o0GxXrcgoKstCFZ3tN5U6r+fzJ2mCwXolsyrxb2U+Ww4/TzqD9vV+GKx0N1ajXvm3ETd2Y8jp6xxo0bjeo3GzatpHNTBNB1OxrPR43g6ahsq2yX1UM1tZKBKRf5mUFmoBJXhoIbpGF0LKtSddNy49Crl45bK9Z+ReNPC+3zi1TuVeNN55xQ9eBy3qmKieYhYdSp2TAvithKu3PZzVzWDU1heUGVBpyRrWM3ATo2q4dUSsPkKVbe26wYNZVzcdZ8rqjq7606l+qvtmdJ5F1fpT7eTSdv7pQWKfmr3S/HnStIuMST5tCN5E5RX8rqiC9Ro3riW5mt2wGUM6Sp+n5tHSrkGdOXLqwZ0Lv+7AV1/xVzIQ5+EhGN57ff3BPOvmm7v5d/NOvRbCKIOy0+dtWo5ZNfE0L7aU2ejEsQHfCAcyjhUoll98Nz8gTInG/odz4OUquvodUh8N+iuhwbRuWSy3SiqF5mv6yXmt/Hk+PiVgpOErnut94pFTJrZm/3kxU/2BQk4/AE=</diagram></mxfile>
--- a/doc/3layer-sketch.png
+++ b/doc/3layer-sketch.png
				`@@ -0,0 +1 @@`
				<mxfile host="app.diagrams.net" modified="2020-11-01T11:07:58.439Z" agent="5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.75 Safari/537.36" etag="2rLqKXNCiuXklA1pgyvi" version="13.8.8" type="device"><diagram id="PODdKzOaVaVDoo3P5bvS" name="Page-1">7Vpbc9o4FP41PDYjW5YvjwnQlE66sJDtbvrSEbYw2hqLESJAf31lW8bXgMmaxu0suYzPkWTL5/u+oyObHuyv9vccr5efmEeCng68fQ8OerquGbrei36Bd1AeG9qJx+fUU77MMaPfiXIC5d1Sj2wKHQVjgaDrotNlYUhcUfBhztmu2G3BguJV19gnFcfMxUHV+zf1xDLx2rqV+T8Q6i/TK2umk7SscNpZ3clmiT22y7ngsAf7nDGRHK32fRJE0Uvjkox7/0LrcWKchKLJgP7Hv54s5z788qc7ctzB5y+LyeidBtXkxCG9Y+LJACiTcbFkPgtxMMy8d5xtQ49Ep9WklfV5YGytnP8SIQ4KTbwVTLqWYhWo1gULhWrUHGlvBGffjvHVox40CPosYDyeE/QwsReu9FdvWsUhmnXOoUJwT9iKCH6QHTgJsKDPRVixYod/7HccOmFUXkIHispHGBWR3xkWKJ5DYO4ToYblcSidSTPPnWnDttwllTPJg9wdZa4Y5wswR8nVnnGwVdH4OLmVjp4BhqGgIopWP8CbjdRdmRxF6HdLKshsjd2odSczQAnmEoiI2J5xhDvXYutzaJqyxY8uq0Yf9QIi4xsR7rKGPii11Rzhiwx5JlyQ/UmOpFiXAEKpY5dlAA0q3zKvfgBe5lUBxosx07ug08jOwQbiz6+hX+i0pV8I31i/hlMR8Chcb0WFIZLuoghoUXkhC0kJK+XCAfVDaboSJiL9d5F4qFwVb1XDinpezLG6FJDxDpR1XBB4qmnwAtVSdtcsdRdrWrPQeVEbNZrWryZpWIFxvBX/43gaR2g0SM4/FUfrNSXUK5Ix2VPxTxTlG6Ssp1zLYK8AiI1DaoTyDnODIvMp35YNi63DCRTrEr+75c/HBaaFVSDJnCeCbardQ5KsT6HS+rry30hivMX6nVJGyxEG3FioKWcAsAusuUGOdoY5sTUhnMq4RRnnIjp1ikHpRq4jDErnnVsuZMHeH//xOB0/PAyns3Zr9TTQlVrddG0yX3SmVjc0o0GxXrcgoKstCFZ3tN5U6r+fzJ2mCwXolsyrxb2U+Ww4/TzqD9vV+GKx0N1ajXvm3ETd2Y8jp6xxo0bjeo3GzatpHNTBNB1OxrPR43g6ahsq2yX1UM1tZKBKRf5mUFmoBJXhoIbpGF0LKtSddNy49Crl45bK9Z+ReNPC+3zi1TuVeNN55xQ9eBy3qmKieYhYdSp2TAvithKu3PZzVzWDU1heUGVBpyRrWM3ATo2q4dUSsPkKVbe26wYNZVzcdZ8rqjq7606l+qvtmdJ5F1fpT7eTSdv7pQWKfmr3S/HnStIuMST5tCN5E5RX8rqiC9Ro3riW5mt2wGUM6Sp+n5tHSrkGdOXLqwZ0Lv+7AV1/xVzIQ5+EhGN57ff3BPOvmm7v5d/NOvRbCKIOy0+dtWo5ZNfE0L7aU2ejEsQHfCAcyjhUoll98Nz8gTInG/odz4OUquvodUh8N+iuhwbRuWSy3SiqF5mv6yXmt/Hk+PiVgpOErnut94pFTJrZm/3kxU/2BQk4/AE=</diagram></mxfile>