Răsfoiți Sursa

SVI Добавление документации; 100.0%

SVI 9 luni în urmă
părinte
comite
81a604388b
3 a modificat fișierele cu 49 adăugiri și 4 ștergeri
  1. 9 4
      README.md
  2. 20 0
      docs/img/mit.svg
  3. 20 0
      docs/img/ucl.svg

+ 9 - 4
README.md

@@ -1,12 +1,17 @@
 # kern
 
 ![Coverage](./docs/img/coverage.svg)
+
 ![MX Linux](https://img.shields.io/badge/-MX%20Linux-%23000000?style=for-the-badge&logo=MXlinux&logoColor=white)
+
 ![Go](https://img.shields.io/badge/go-%2300ADD8.svg?style=for-the-badge&logo=go&logoColor=white)
+
 ![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)
+
 ![Visual Studio Code](https://img.shields.io/badge/Visual%20Studio%20Code-0078d7.svg?style=for-the-badge&logo=visual-studio-code&logoColor=white)
 
-[![License: UCL](UCL)](./LICENSE.md)
+![License: UCL](./docs/img/ucl.svg) / ![License: MIT](./docs/img/mit.svg)
+
 
 **kern** -- фреймворк модульных компонентов ядра с высокой надёжностью для любого микросервиса или модульного монолита. Позволяет создавать изолированные модули в составе монолита (полезно в начале разработки). А затем модули можно выносить в отдельные микросервисы (после отладки).
 
@@ -16,7 +21,7 @@
 
 ## Статус проекта
 
-* готовность: `92%`;
+* готовность: `96%`;
 * покрытие тестами: `100%`;
 * линтеры: `no errors`;
 * цикломатическая сложность: `< 11`.
@@ -35,11 +40,11 @@ TODO: update
 
 ## Версия компилятора
 
-Не ниже `go 1.24.0`
+Не ниже `go 1.24.2`
 
 ## Лицензия
 
-Код открытый, [лицензия UCL](./LICENSE.md) или `MIT`.
+v1, v2 (код открытый, [лицензия UCL](./LICENSE.md) или `MIT` .)
 
 ## Команды сборки
 

+ 20 - 0
docs/img/mit.svg

@@ -0,0 +1,20 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="103.3" height="20" viewBox="0 0 1033 200" role="img" aria-label="coverage: 100%">
+  <title>coverage: 100%</title>
+  <linearGradient id="enYYm" x2="0" y2="100%">
+    <stop offset="0" stop-opacity=".1" stop-color="#EEE"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <mask id="XTWfx"><rect width="1033" height="200" rx="30" fill="#FFF"/></mask>
+  <g mask="url(#XTWfx)">
+    <rect width="603" height="200" fill="#555"/>
+    <rect width="430" height="200" fill="#3C1" x="603"/>
+    <rect width="1033" height="200" fill="url(#enYYm)"/>
+  </g>
+  <g aria-hidden="true" fill="#fff" text-anchor="start" font-family="Verdana,DejaVu Sans,sans-serif" font-size="110">
+    <text x="60" y="148" textLength="503" fill="#000" opacity="0.25">License</text>
+    <text x="50" y="138" textLength="503">License</text>
+    <text x="658" y="148" textLength="330" fill="#000" opacity="0.25">MIT</text>
+    <text x="648" y="138" textLength="330">MIT</text>
+  </g>
+
+</svg>

+ 20 - 0
docs/img/ucl.svg

@@ -0,0 +1,20 @@
+<svg xmlns="http://www.w3.org/2000/svg" width="103.3" height="20" viewBox="0 0 1033 200" role="img" aria-label="coverage: 100%">
+  <title>coverage: 100%</title>
+  <linearGradient id="enYYm" x2="0" y2="100%">
+    <stop offset="0" stop-opacity=".1" stop-color="#EEE"/>
+    <stop offset="1" stop-opacity=".1"/>
+  </linearGradient>
+  <mask id="XTWfx"><rect width="1033" height="200" rx="30" fill="#FFF"/></mask>
+  <g mask="url(#XTWfx)">
+    <rect width="603" height="200" fill="#555"/>
+    <rect width="430" height="200" fill="#3C1" x="603"/>
+    <rect width="1033" height="200" fill="url(#enYYm)"/>
+  </g>
+  <g aria-hidden="true" fill="#fff" text-anchor="start" font-family="Verdana,DejaVu Sans,sans-serif" font-size="110">
+    <text x="60" y="148" textLength="503" fill="#000" opacity="0.25">License</text>
+    <text x="50" y="138" textLength="503">License</text>
+    <text x="658" y="148" textLength="330" fill="#000" opacity="0.25">UCL</text>
+    <text x="648" y="138" textLength="330">UCL</text>
+  </g>
+
+</svg>