From b59567d15be9e35ce5234b6850351b0fb34550aa Mon Sep 17 00:00:00 2001
From: eraden <adrian.wozniak@ita-prog.pl>
Date: Mon, 10 Apr 2023 21:25:31 +0200
Subject: [PATCH] Readme

---
 README.md           |   2 +-
 assets/candida.svg  | 209 ++++++++++++++++++++++++++++++++++++++++++++
 assets/session.puml |   6 +-
 assets/stream.puml  |   2 +-
 4 files changed, 214 insertions(+), 5 deletions(-)
 create mode 100644 assets/candida.svg

diff --git a/README.md b/README.md
index 2badf04..9c4e1f6 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
 # Puffball
 
 <div style="text-align: center">
-<img style="width: 128px; margin: 0 auto;" src="https://code.ita-prog.pl/Tsumanu/puffball/raw/branch/master/assets/puffball.svg">
+<img style="width: 128px; margin: 0 auto;" src="https://code.ita-prog.pl/Tsumanu/puffball/raw/branch/master/assets/candida.svg">
 </div>
 
 Web server for WebDAV resources
diff --git a/assets/candida.svg b/assets/candida.svg
new file mode 100644
index 0000000..b3bb494
--- /dev/null
+++ b/assets/candida.svg
@@ -0,0 +1,209 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<!-- Created with Inkscape (http://www.inkscape.org/) -->
+
+<svg
+   width="193.37465mm"
+   height="145.51175mm"
+   viewBox="0 0 193.37465 145.51175"
+   version="1.1"
+   id="svg5"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg">
+  <sodipodi:namedview
+     id="namedview7"
+     pagecolor="#505050"
+     bordercolor="#eeeeee"
+     borderopacity="1"
+     inkscape:showpageshadow="0"
+     inkscape:pageopacity="0"
+     inkscape:pagecheckerboard="0"
+     inkscape:deskcolor="#505050"
+     inkscape:document-units="mm"
+     showgrid="false" />
+  <defs
+     id="defs2" />
+  <g
+     inkscape:label="Warstwa 1"
+     inkscape:groupmode="layer"
+     id="layer1"
+     transform="translate(-13.226156,-63.893423)">
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path115-6"
+       cx="110.12693"
+       cy="143.01611"
+       rx="95.891373"
+       ry="65.806564" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path115"
+       cx="109.70003"
+       cy="130.28249"
+       rx="95.891373"
+       ry="65.806564" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 149.92922,152.62914 18.02304,-12.96285 v 0 z"
+       id="path3747" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-7"
+       cx="148.61588"
+       cy="153.37639"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 89.900785,150.87759 46.646005,19.96507 v 0 l 4.61931,-6.36554 -46.729915,-18.30543 v 0 z"
+       id="path3739" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-0"
+       cx="115.97699"
+       cy="156.47324"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-93"
+       cx="112.2288"
+       cy="160.14418"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.4635;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-18"
+       cx="75.222351"
+       cy="127.20227"
+       rx="6.5359678"
+       ry="6.2729011" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 67.103915,150.31016 21.107919,-4.11582 z"
+       id="path3737" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.538;stroke-dasharray:none;stroke-opacity:1"
+       d="m 75.273277,120.52658 c 11.444737,25.0603 12.292369,26.02062 12.292369,26.02062 l 6.709159,-2.10905 -15.340904,-31.54585 -5.693347,3.04209 z"
+       id="path3735" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-6"
+       cx="90.099258"
+       cy="146.03183"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-26"
+       cx="62.535213"
+       cy="150.80966"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:0.959544;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-06"
+       cx="91.417908"
+       cy="153.51025"
+       rx="4.2198844"
+       ry="4.1765947" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.25384;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7"
+       cx="81.404739"
+       cy="113.82052"
+       rx="5.5998511"
+       ry="5.3740802" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 104.29951,91.214121 11.08742,25.010619 -3.11151,2.6946 -12.323498,-26.963306 z"
+       id="path3755" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5"
+       cx="102.18565"
+       cy="90.442902"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="M 121.47409,118.67026 136.55745,97.898007 Z"
+       id="path3753" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3"
+       cx="137.12354"
+       cy="96.343582"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 124.04081,118.22005 19.06466,-16.63112 v 0 z"
+       id="path3751" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5"
+       cx="143.01889"
+       cy="100.0678"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6"
+       cx="114.72227"
+       cy="119.71986"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2"
+       cx="122.43711"
+       cy="120.2167"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 193.17467,127.62651 -23.82782,4.931 -42.34371,-10.18966 -4.58867,7.15274 45.66833,10.69714 25.4222,-4.919 v 0 0 z"
+       id="path3745" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.4495;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-9"
+       cx="121.2823"
+       cy="127.5013"
+       rx="6.3285193"
+       ry="6.3551588" />
+    <path
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       d="m 169.35351,135.70232 4.11182,-12.49932 v 0 z"
+       id="path3749" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.42307;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-2"
+       cx="172.8726"
+       cy="120.84007"
+       rx="6.1166277"
+       ry="6.3377366" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187-7-5-3-5-6-2-1"
+       cx="169.77576"
+       cy="112.8615"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3187"
+       cx="72.473137"
+       cy="118.40921"
+       rx="4.8897057"
+       ry="5.3132758" />
+    <ellipse
+       style="fill:#ffffff;fill-opacity:1;stroke:#000000;stroke-width:1.165;stroke-dasharray:none;stroke-opacity:1"
+       id="path3185"
+       cx="72.776825"
+       cy="108.96877"
+       rx="5.2666564"
+       ry="5.4111762" />
+  </g>
+</svg>
diff --git a/assets/session.puml b/assets/session.puml
index 64449d7..1d55e19 100644
--- a/assets/session.puml
+++ b/assets/session.puml
@@ -10,7 +10,7 @@ Pathfinder -> Client : OK with Check e-mail
 else Invalid data
 Keeper -> Pathfinder : Failed
 Pathfinder -> Client : BAD_REQUEST with errors
-end
+end :
 end
 
 group Sign In (First step)
@@ -37,7 +37,7 @@ Pathfinder -> Client : FOUND with JWT
 else Invalid token
 Mailman -> Pathfinder : Not found
 Pathfinder -> Client : UNAUTHORIZED
-end
+end :
 end
 
 group Check session
@@ -49,7 +49,7 @@ Pathfinder -> Client : FOUND
 else Invalid JWT
 Sentinel -> Pathfinder : Invalid
 Pathfinder -> Client : UNAUTHORIZED
-end
+end :
 end
 
 @enduml
diff --git a/assets/stream.puml b/assets/stream.puml
index 1dd6515..a81e92c 100644
--- a/assets/stream.puml
+++ b/assets/stream.puml
@@ -1,6 +1,6 @@
 @startuml
 
-Client -> Pathfinder
+Client -> Pathfinder : File request
 Pathfinder -> Sentinel : Check authorization
 
 alt User Authorized