Readme fix (#2829)

saiyam1814 · web-flow · commit 2b7728785792 · 2025-05-23T10:26:37.000+02:00
* fixing readme

* Readme fix

* deleted irrelevent files

* deleted irrelevent files

* deleted irrelevent files
diff --git a/docs/static/media/vcluster-github-gif-1280.gif b/docs/static/media/vcluster-github-gif-1280.gif
diff --git a/docs/static/media/vcluster_horizontal_orange_black.svg b/docs/static/media/vcluster_horizontal_orange_black.svg
@@ -0,0 +1,13 @@
+<svg width="600" height="183" viewBox="0 0 600 183" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M171.35 27.4L140.5 81.86L140.31 82.19L125.97 107.5L108.36 76.44L128.86 40.37L128.88 40.35C129.16 39.81 129.47 39.27 129.79 38.76V38.74L129.81 38.72C135.1 30.04 144.5 24.14 155.31 23.73C155.72 23.71 156.14 23.71 156.55 23.71C156.96 23.71 157.37 23.71 157.79 23.73C162.69 23.92 167.3 25.24 171.36 27.43V27.41L171.35 27.4Z" fill="#FF6600"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M117.45 29.76L99.7603 60.87H56.8603C46.6203 60.87 37.0903 55.82 31.3303 47.48C31.2903 47.42 31.2403 47.35 31.2003 47.3C31.1103 47.17 31.0303 47.05 30.9503 46.92C30.5603 46.34 30.2103 45.75 29.8603 45.14L29.5403 44.57C27.1703 40.2 25.8203 35.2 25.8203 29.88V29.76H117.45Z" fill="#FF6600"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M116.591 129.53C116.591 141.05 110.271 151.09 100.901 156.39L70.5306 102.75L55.6006 76.39H90.9906L112.321 113.88C112.321 113.88 112.341 113.93 112.361 113.94L112.571 114.31C113.331 115.65 113.991 117.03 114.531 118.45C114.561 118.53 114.591 118.61 114.621 118.69C115.891 122.06 116.591 125.72 116.591 129.54V129.53Z" fill="#FF6600"/>
+<path d="M219.63 108.49L209.47 77.51C208.19 73.6 204.54 70.96 200.42 70.96H193.95L211.92 120.01H227.14L245.29 70.96H238.82C234.71 70.96 231.05 73.6 229.77 77.51L219.61 108.49H219.63Z" fill="#050B24"/>
+<path d="M379.6 96.63C379.6 99.17 379.15 101.44 378.27 103.45C377.38 105.46 376.12 107.03 374.46 108.18C372.8 109.33 370.86 109.91 368.62 109.91C365.38 109.91 362.75 108.83 360.74 106.68C358.73 104.53 357.73 101.47 357.73 97.52V70.96H345.33V99.64C345.33 104.07 346.09 107.85 347.63 110.97C349.16 114.1 351.36 116.49 354.23 118.14C357.1 119.8 360.47 120.61 364.37 120.61C367.38 120.61 370.13 119.86 372.65 118.35C375.15 116.84 377.22 114.5 378.85 111.31C379.12 110.78 379.37 110.22 379.6 109.63V113.34C379.6 115.35 380.2 116.95 381.41 118.16C382.62 119.37 384.22 119.97 386.23 119.97H392.16V70.92H379.59V96.62L379.61 96.64L379.6 96.63Z" fill="#050B24"/>
+<path d="M434.521 94.51C432.421 93.44 430.201 92.61 427.831 91.99C425.471 91.37 423.241 90.78 421.151 90.22C419.051 89.66 417.341 88.98 416.011 88.19C414.681 87.39 414.021 86.26 414.021 84.77C414.021 83.28 414.611 82.22 415.791 81.35C416.971 80.49 418.691 80.07 420.931 80.07C423.291 80.07 425.131 80.62 426.471 81.71C427.801 82.8 428.731 84.38 429.261 86.44L440.591 83.43C439.941 80.78 438.761 78.46 437.051 76.48C435.341 74.5 433.161 72.98 430.501 71.93C427.851 70.86 424.781 70.34 421.291 70.34C417.271 70.34 413.821 70.99 410.931 72.29C408.041 73.59 405.811 75.36 404.241 77.61C402.681 79.86 401.891 82.31 401.891 84.96C401.891 87.97 402.551 90.37 403.881 92.18C405.211 93.98 406.931 95.4 409.051 96.43C411.171 97.47 413.421 98.29 415.781 98.9C418.141 99.52 420.371 100.08 422.471 100.59C424.571 101.09 426.281 101.74 427.611 102.54C428.941 103.34 429.601 104.47 429.601 105.96C429.601 107.45 428.961 108.56 427.701 109.5C426.441 110.44 424.561 110.92 422.081 110.92C419.961 110.92 418.101 110.35 416.511 109.19C414.921 108.04 413.861 106.49 413.321 104.54L401.631 107.19C402.391 109.73 403.731 112.03 405.611 114.09C407.491 116.15 409.861 117.76 412.691 118.91C415.521 120.06 418.701 120.64 422.251 120.64C426.201 120.64 429.631 119.99 432.511 118.69C435.401 117.39 437.651 115.64 439.241 113.42C440.831 111.21 441.631 108.77 441.631 106.12C441.631 103.11 440.971 100.69 439.641 98.86C438.311 97.03 436.601 95.59 434.501 94.52H434.531L434.521 94.51Z" fill="#050B24"/>
+<path d="M522.519 107.03C520.959 108.18 519.259 109.08 517.429 109.73C515.599 110.37 513.709 110.7 511.769 110.7C509.519 110.7 507.429 110.33 505.489 109.59C503.539 108.85 501.899 107.81 500.569 106.45C499.239 105.09 498.399 103.62 498.049 102.02C498.219 102.02 498.599 102.04 499.159 102.06C499.729 102.09 500.349 102.11 501.059 102.11C501.769 102.11 502.389 102.14 502.909 102.2C506.269 102.33 509.699 102.15 513.179 101.71C516.669 101.26 519.869 100.45 522.789 99.23C525.709 98.02 528.059 96.39 529.829 94.31C531.599 92.24 532.479 89.68 532.479 86.61C532.479 84.25 531.929 82.07 530.839 80.06C529.749 78.05 528.209 76.33 526.229 74.89C524.249 73.45 521.969 72.32 519.369 71.53C516.769 70.73 513.999 70.34 511.049 70.34C507.559 70.34 504.259 70.94 501.129 72.15C497.999 73.36 495.229 75.09 492.809 77.32C490.389 79.57 488.509 82.25 487.139 85.38C485.779 88.51 485.109 91.99 485.109 95.82C485.109 99.65 485.769 102.92 487.099 105.96C488.429 109 490.279 111.61 492.669 113.79C495.059 115.98 497.859 117.65 501.079 118.84C504.299 120.02 507.789 120.61 511.569 120.61C514.639 120.61 517.579 120.23 520.429 119.46C523.259 118.7 525.919 117.5 528.399 115.87C530.869 114.25 533.059 112.2 534.949 109.71L526.359 103.25C525.359 104.61 524.069 105.86 522.509 107.01V107.03H522.519ZM499.289 86.84C500.469 84.86 502.099 83.25 504.209 82.02C506.309 80.78 508.709 80.16 511.419 80.16C513.129 80.16 514.649 80.44 515.969 81C517.299 81.57 518.359 82.3 519.149 83.21C519.949 84.12 520.339 85.17 520.339 86.35C520.339 87.77 519.819 88.93 518.789 89.85C517.759 90.76 516.399 91.47 514.709 91.97C513.019 92.47 511.199 92.81 509.219 92.98C507.239 93.15 505.289 93.25 503.329 93.25C502.149 93.25 501.029 93.22 499.969 93.16C498.899 93.11 498.019 93.04 497.319 92.99C497.439 90.87 498.079 88.81 499.269 86.83H499.289V86.84Z" fill="#050B24"/>
+<path d="M339.41 115.01C340.42 117.08 341.65 118.94 343.07 120.62H330.1C323.17 120.62 317.55 115 317.55 108.07V57.59H330.03V106.47C330.03 108.17 331.41 109.56 333.12 109.56H337.38C337.9 111.5 338.57 113.31 339.41 115.02V115.01Z" fill="#050B24"/>
+<path d="M486.5 120.57C483.17 117.52 480.54 113.85 478.7 109.63C478.68 109.6 478.68 109.58 478.66 109.54H471C469.21 109.54 467.76 108.09 467.76 106.3V81.13H479C480.77 77.25 483.19 73.83 486.21 70.95H462.55C462.88 70.88 463.19 70.79 463.48 70.67C463.86 70.54 464.21 70.36 464.54 70.16C464.8 70 465.05 69.82 465.28 69.63C465.73 69.25 466.12 68.82 466.46 68.37C466.7 68.05 466.91 67.7 467.1 67.33C467.16 67.2 467.23 67.07 467.28 66.94C467.6 66.19 467.76 65.42 467.76 64.67V57.59H455.36V66.71C455.36 67.75 455.12 68.63 454.64 69.33C454.52 69.5 454.4 69.66 454.26 69.81C454.15 69.92 454.04 70.02 453.92 70.12C453.22 70.69 452.32 70.96 451.2 70.96H447.48V81.14H455.09V109.56C455.09 112.61 456.33 115.39 458.34 117.38C460.34 119.38 463.11 120.61 466.17 120.61H486.55C486.55 120.61 486.51 120.58 486.5 120.56V120.58V120.57Z" fill="#050B24"/>
+<path d="M296.88 97.76H310.12C309.77 99.12 309.34 100.43 308.82 101.71C307.26 105.57 305.06 108.91 302.22 111.71C299.39 114.51 296.06 116.7 292.26 118.26C288.48 119.81 284.27 120.59 279.82 120.61C275.37 120.59 271.27 119.82 267.49 118.26C263.68 116.7 260.37 114.51 257.53 111.71C254.7 108.91 252.5 105.57 250.93 101.71C249.36 97.85 248.58 93.61 248.58 89.01C248.58 84.41 249.37 80.18 250.97 76.34C252.57 72.5 254.78 69.19 257.6 66.38C260.43 63.57 263.76 61.41 267.56 59.87C271.33 58.35 275.41 57.58 279.8 57.58H279.9C284.28 57.6 288.36 58.36 292.14 59.88C295.95 61.41 299.27 63.59 302.1 66.39C304.93 69.19 307.15 72.51 308.73 76.35C309.28 77.67 309.73 79.03 310.09 80.43H296.86C296.58 79.69 296.26 78.99 295.89 78.29C294.3 75.28 292.1 72.94 289.29 71.25C286.57 69.61 283.46 68.78 279.97 68.73H279.68C276.19 68.78 273.08 69.62 270.36 71.25C267.55 72.94 265.36 75.28 263.76 78.29C262.17 81.3 261.37 84.87 261.37 89C261.37 93.13 262.16 96.73 263.72 99.8C265.28 102.87 267.45 105.24 270.23 106.93C273 108.61 276.18 109.45 279.78 109.46C283.37 109.46 286.66 108.62 289.43 106.93C292.21 105.24 294.38 102.88 295.94 99.8C296.27 99.15 296.58 98.46 296.84 97.75L296.88 97.76Z" fill="#050B24"/>
+<path d="M575.971 71.09L570.751 82.24C569.331 81.59 567.721 81.27 565.931 81.27C563.651 81.27 561.671 81.85 560.001 83.02C558.331 84.19 557.031 85.78 556.141 87.82C555.241 89.85 554.801 92.15 554.801 94.73V120.74H550.651C545.891 120.74 542.041 116.88 542.041 112.13V71.03H548.051C550.081 71.03 551.721 71.64 552.941 72.87C554.171 74.09 554.791 75.73 554.791 77.75V81.51C555.031 80.92 555.281 80.35 555.551 79.81C557.201 76.58 559.301 74.2 561.841 72.68C564.381 71.16 567.191 70.39 570.241 70.39C572.291 70.39 574.211 70.61 575.981 71.07L575.961 71.09H575.971Z" fill="#050B24"/>
+</svg>
diff --git a/docs/static/media/vcluster_horizontal_orange_white.svg b/docs/static/media/vcluster_horizontal_orange_white.svg
@@ -0,0 +1,13 @@
+<svg width="600" height="183" viewBox="0 0 600 183" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M171.349 27.4L140.499 81.86L140.309 82.19L125.969 107.5L108.359 76.44L128.859 40.37L128.879 40.35C129.159 39.81 129.469 39.27 129.789 38.76V38.74L129.809 38.72C135.099 30.04 144.499 24.14 155.309 23.73C155.719 23.71 156.139 23.71 156.549 23.71C156.959 23.71 157.369 23.71 157.789 23.73C162.689 23.92 167.299 25.24 171.359 27.43V27.41L171.349 27.4Z" fill="#FF6600"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M117.45 29.76L99.7603 60.87H56.8603C46.6203 60.87 37.0903 55.82 31.3303 47.48C31.2903 47.42 31.2403 47.35 31.2003 47.3C31.1103 47.17 31.0303 47.05 30.9503 46.92C30.5603 46.34 30.2103 45.75 29.8603 45.14L29.5403 44.57C27.1703 40.2 25.8203 35.2 25.8203 29.88V29.76H117.45Z" fill="#FF6600"/>
+<path fill-rule="evenodd" clip-rule="evenodd" d="M116.59 129.53C116.59 141.05 110.27 151.09 100.9 156.39L70.5296 102.75L55.5996 76.39H90.9896L112.32 113.88C112.32 113.88 112.34 113.93 112.36 113.94L112.57 114.31C113.33 115.65 113.99 117.03 114.53 118.45C114.56 118.53 114.59 118.61 114.62 118.69C115.89 122.06 116.59 125.72 116.59 129.54V129.53Z" fill="#FF6600"/>
+<path d="M219.629 108.49L209.469 77.51C208.189 73.6 204.539 70.96 200.419 70.96H193.949L211.919 120.01H227.139L245.289 70.96H238.819C234.709 70.96 231.049 73.6 229.769 77.51L219.609 108.49H219.629Z" fill="white"/>
+<path d="M379.6 96.63C379.6 99.17 379.15 101.44 378.27 103.45C377.38 105.46 376.12 107.03 374.46 108.18C372.8 109.33 370.86 109.91 368.62 109.91C365.38 109.91 362.75 108.83 360.74 106.68C358.73 104.53 357.73 101.47 357.73 97.52V70.96H345.33V99.64C345.33 104.07 346.09 107.85 347.63 110.97C349.16 114.1 351.36 116.49 354.23 118.14C357.1 119.8 360.47 120.61 364.37 120.61C367.38 120.61 370.13 119.86 372.65 118.35C375.15 116.84 377.22 114.5 378.85 111.31C379.12 110.78 379.37 110.22 379.6 109.63V113.34C379.6 115.35 380.2 116.95 381.41 118.16C382.62 119.37 384.22 119.97 386.23 119.97H392.16V70.92H379.59V96.62L379.61 96.64L379.6 96.63Z" fill="white"/>
+<path d="M434.519 94.51C432.419 93.44 430.199 92.61 427.829 91.99C425.469 91.37 423.239 90.78 421.149 90.22C419.049 89.66 417.339 88.98 416.009 88.19C414.679 87.39 414.019 86.26 414.019 84.77C414.019 83.28 414.609 82.22 415.789 81.35C416.969 80.49 418.689 80.07 420.929 80.07C423.289 80.07 425.129 80.62 426.469 81.71C427.799 82.8 428.729 84.38 429.259 86.44L440.589 83.43C439.939 80.78 438.759 78.46 437.049 76.48C435.339 74.5 433.159 72.98 430.499 71.93C427.849 70.86 424.779 70.34 421.289 70.34C417.269 70.34 413.819 70.99 410.929 72.29C408.039 73.59 405.809 75.36 404.239 77.61C402.679 79.86 401.889 82.31 401.889 84.96C401.889 87.97 402.549 90.37 403.879 92.18C405.209 93.98 406.929 95.4 409.049 96.43C411.169 97.47 413.419 98.29 415.779 98.9C418.139 99.52 420.369 100.08 422.469 100.59C424.569 101.09 426.279 101.74 427.609 102.54C428.939 103.34 429.599 104.47 429.599 105.96C429.599 107.45 428.959 108.56 427.699 109.5C426.439 110.44 424.559 110.92 422.079 110.92C419.959 110.92 418.099 110.35 416.509 109.19C414.919 108.04 413.859 106.49 413.319 104.54L401.629 107.19C402.389 109.73 403.729 112.03 405.609 114.09C407.489 116.15 409.859 117.76 412.689 118.91C415.519 120.06 418.699 120.64 422.249 120.64C426.199 120.64 429.629 119.99 432.509 118.69C435.399 117.39 437.649 115.64 439.239 113.42C440.829 111.21 441.629 108.77 441.629 106.12C441.629 103.11 440.969 100.69 439.639 98.86C438.309 97.03 436.599 95.59 434.499 94.52H434.529L434.519 94.51Z" fill="white"/>
+<path d="M522.519 107.03C520.959 108.18 519.259 109.08 517.429 109.73C515.599 110.37 513.709 110.7 511.769 110.7C509.519 110.7 507.429 110.33 505.489 109.59C503.539 108.85 501.899 107.81 500.569 106.45C499.239 105.09 498.399 103.62 498.049 102.02C498.219 102.02 498.599 102.04 499.159 102.06C499.729 102.09 500.349 102.11 501.059 102.11C501.769 102.11 502.389 102.14 502.909 102.2C506.269 102.33 509.699 102.15 513.179 101.71C516.669 101.26 519.869 100.45 522.789 99.23C525.709 98.02 528.059 96.39 529.829 94.31C531.599 92.24 532.479 89.68 532.479 86.61C532.479 84.25 531.929 82.07 530.839 80.06C529.749 78.05 528.209 76.33 526.229 74.89C524.249 73.45 521.969 72.32 519.369 71.53C516.769 70.73 513.999 70.34 511.049 70.34C507.559 70.34 504.259 70.94 501.129 72.15C497.999 73.36 495.229 75.09 492.809 77.32C490.389 79.57 488.509 82.25 487.139 85.38C485.779 88.51 485.109 91.99 485.109 95.82C485.109 99.65 485.769 102.92 487.099 105.96C488.429 109 490.279 111.61 492.669 113.79C495.059 115.98 497.859 117.65 501.079 118.84C504.299 120.02 507.789 120.61 511.569 120.61C514.639 120.61 517.579 120.23 520.429 119.46C523.259 118.7 525.919 117.5 528.399 115.87C530.869 114.25 533.059 112.2 534.949 109.71L526.359 103.25C525.359 104.61 524.069 105.86 522.509 107.01V107.03H522.519ZM499.289 86.84C500.469 84.86 502.099 83.25 504.209 82.02C506.309 80.78 508.709 80.16 511.419 80.16C513.129 80.16 514.649 80.44 515.969 81C517.299 81.57 518.359 82.3 519.149 83.21C519.949 84.12 520.339 85.17 520.339 86.35C520.339 87.77 519.819 88.93 518.789 89.85C517.759 90.76 516.399 91.47 514.709 91.97C513.019 92.47 511.199 92.81 509.219 92.98C507.239 93.15 505.289 93.25 503.329 93.25C502.149 93.25 501.029 93.22 499.969 93.16C498.899 93.11 498.019 93.04 497.319 92.99C497.439 90.87 498.079 88.81 499.269 86.83H499.289V86.84Z" fill="white"/>
+<path d="M339.409 115.01C340.419 117.08 341.649 118.94 343.069 120.62H330.099C323.169 120.62 317.549 115 317.549 108.07V57.59H330.029V106.47C330.029 108.17 331.409 109.56 333.119 109.56H337.379C337.899 111.5 338.569 113.31 339.409 115.02V115.01Z" fill="white"/>
+<path d="M486.499 120.57C483.169 117.52 480.539 113.85 478.699 109.63C478.679 109.6 478.679 109.58 478.659 109.54H470.999C469.209 109.54 467.759 108.09 467.759 106.3V81.13H478.999C480.769 77.25 483.188 73.83 486.208 70.95H462.548C462.878 70.88 463.189 70.79 463.479 70.67C463.859 70.54 464.209 70.36 464.539 70.16C464.799 70 465.049 69.82 465.279 69.63C465.729 69.25 466.118 68.82 466.458 68.37C466.698 68.05 466.909 67.7 467.099 67.33C467.159 67.2 467.229 67.07 467.279 66.94C467.599 66.19 467.759 65.42 467.759 64.67V57.59H455.358V66.71C455.358 67.75 455.119 68.63 454.639 69.33C454.519 69.5 454.399 69.66 454.259 69.81C454.149 69.92 454.039 70.02 453.919 70.12C453.219 70.69 452.319 70.96 451.199 70.96H447.479V81.14H455.089V109.56C455.089 112.61 456.329 115.39 458.339 117.38C460.339 119.38 463.109 120.61 466.169 120.61H486.548C486.548 120.61 486.509 120.58 486.499 120.56V120.58V120.57Z" fill="white"/>
+<path d="M296.88 97.76H310.12C309.77 99.12 309.34 100.43 308.82 101.71C307.26 105.57 305.06 108.91 302.22 111.71C299.39 114.51 296.06 116.7 292.26 118.26C288.48 119.81 284.27 120.59 279.82 120.61C275.37 120.59 271.27 119.82 267.49 118.26C263.68 116.7 260.37 114.51 257.53 111.71C254.7 108.91 252.5 105.57 250.93 101.71C249.36 97.85 248.58 93.61 248.58 89.01C248.58 84.41 249.37 80.18 250.97 76.34C252.57 72.5 254.78 69.19 257.6 66.38C260.43 63.57 263.76 61.41 267.56 59.87C271.33 58.35 275.41 57.58 279.8 57.58H279.9C284.28 57.6 288.36 58.36 292.14 59.88C295.95 61.41 299.27 63.59 302.1 66.39C304.93 69.19 307.15 72.51 308.73 76.35C309.28 77.67 309.73 79.03 310.09 80.43H296.86C296.58 79.69 296.26 78.99 295.89 78.29C294.3 75.28 292.1 72.94 289.29 71.25C286.57 69.61 283.46 68.78 279.97 68.73H279.68C276.19 68.78 273.08 69.62 270.36 71.25C267.55 72.94 265.36 75.28 263.76 78.29C262.17 81.3 261.37 84.87 261.37 89C261.37 93.13 262.16 96.73 263.72 99.8C265.28 102.87 267.45 105.24 270.23 106.93C273 108.61 276.18 109.45 279.78 109.46C283.37 109.46 286.66 108.62 289.43 106.93C292.21 105.24 294.38 102.88 295.94 99.8C296.27 99.15 296.58 98.46 296.84 97.75L296.88 97.76Z" fill="white"/>
+<path d="M575.969 71.09L570.749 82.24C569.329 81.59 567.719 81.27 565.929 81.27C563.649 81.27 561.669 81.85 559.999 83.02C558.329 84.19 557.029 85.78 556.139 87.82C555.239 89.85 554.799 92.15 554.799 94.73V120.74H550.649C545.889 120.74 542.039 116.88 542.039 112.13V71.03H548.049C550.079 71.03 551.719 71.64 552.939 72.87C554.169 74.09 554.789 75.73 554.789 77.75V81.51C555.029 80.92 555.279 80.35 555.549 79.81C557.199 76.58 559.299 74.2 561.839 72.68C564.379 71.16 567.189 70.39 570.239 70.39C572.289 70.39 574.209 70.61 575.979 71.07L575.959 71.09H575.969Z" fill="white"/>
+</svg>
