feat: readme

npldevfr · Jan 22, 2024 · 9f4fce9 · 9f4fce9
1 parent 957c9c4
commit 9f4fce9
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 1 deletion.
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) Nuno Maduro <enunomaduro@gmail.com>
+Copyright (c) npldevfr <npldevfr@kcn.gg>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,4 +1,48 @@
 
+
+<br />
+<p align="center">
+ <svg width="373" height="71" viewBox="0 0 373 71" fill="none" xmlns="http://www.w3.org/2000/svg">
+<g clip-path="url(#clip0_1536_519)">
+<path d="M118.807 13.1972H126.311V54.9292H118.807V13.1972ZM134.369 13.9238H141.873V21.0527H134.369V13.9238ZM134.369 26.2765H141.873V54.9292H134.369V26.2765ZM168.71 51.6496H168.592C165.965 54.8114 163.338 55.5969 160.14 55.5969C151.134 55.5969 147.896 48.3698 147.896 40.5145C147.896 32.6197 151.134 25.6088 160.14 25.6088C164.385 25.6088 167.13 27.3959 168.927 30.3416H169.045V26.2765H176.214V66.6141H168.71V51.6496ZM155.735 40.5145C155.735 44.4618 157.138 49.8035 162.054 49.8035C167.031 49.8035 168.65 44.5796 168.65 40.5145C168.65 36.5082 166.755 31.3826 161.936 31.3826C157.078 31.4021 155.735 36.685 155.735 40.5145ZM210.397 54.9292H203.288V51.0407H203.17C200.88 53.8294 197.641 55.5969 193.711 55.5969C186.878 55.5969 183.915 50.805 183.915 44.3636V26.2765H191.419V41.575C191.419 45.0707 191.479 49.8035 196.278 49.8035C201.709 49.8035 202.873 43.9709 202.873 40.2984V26.2765H210.378V54.9292H210.397ZM218.277 13.9238H225.78V21.0527H218.277V13.9238ZM218.277 26.2765H225.78V54.9292H218.277V26.2765ZM233.66 26.2765H240.829V30.3416H240.947C242.625 27.5529 245.469 25.6088 249.893 25.6088C258.74 25.6088 261.979 32.6197 261.979 40.5145C261.979 48.3503 258.74 55.5969 249.735 55.5969C246.556 55.5969 243.909 54.8114 241.283 51.6496H241.165V66.6141H233.66V26.2765ZM241.223 40.5145C241.223 44.5796 242.844 49.8035 247.819 49.8035C252.737 49.8035 254.138 44.4618 254.138 40.5145C254.138 36.685 252.795 31.3826 247.937 31.3826C243.119 31.4021 241.223 36.5082 241.223 40.5145ZM290.949 53.3188C288.204 54.8114 285.083 55.5969 281.054 55.5969C271.537 55.5969 266.007 50.1375 266.007 40.7501C266.007 32.4627 270.431 25.6088 279.376 25.6088C290.06 25.6088 293.081 32.8947 293.081 42.9104H273.175C273.511 47.5254 276.75 50.1375 281.391 50.1375C285.025 50.1375 288.163 48.8019 290.949 47.2505V53.3188ZM285.912 37.7848C285.695 34.1711 284.016 31.0486 279.81 31.0486C275.624 31.0486 273.491 33.9355 273.156 37.7848H285.912ZM318.142 51.7084H318.022C315.791 54.4971 312.71 55.5969 309.175 55.5969C300.328 55.5969 297.09 48.3698 297.09 40.5145C297.09 32.6197 300.328 25.6087 309.175 25.6087C312.927 25.6087 315.554 26.8852 317.786 29.615H317.904V13.1972H325.408V54.9292H318.142V51.7084ZM311.269 49.8035C316.244 49.8035 317.865 44.5796 317.865 40.5145C317.865 36.5082 315.969 31.3824 311.151 31.3824C306.293 31.3824 304.95 36.6653 304.95 40.5145C304.95 44.4618 306.332 49.8035 311.269 49.8035ZM333.308 13.9238H340.811V21.0527H333.308V13.9238ZM333.308 26.2765H340.811V54.9292H333.308V26.2765ZM349.975 27.7887C352.877 26.4532 356.807 25.6284 359.986 25.6284C368.773 25.6284 372.407 29.2419 372.407 37.7061V41.3785C372.407 44.2655 372.467 46.4453 372.527 48.5466C372.585 50.7069 372.684 52.71 372.862 54.9488H366.266C365.989 53.4562 365.989 51.5514 365.931 50.6676H365.811C364.074 53.8295 360.323 55.6165 356.925 55.6165C351.831 55.6165 346.854 52.5529 346.854 47.113C346.854 42.8318 348.927 40.318 351.771 38.9434C354.615 37.549 358.307 37.274 361.447 37.274H365.594C365.594 32.659 363.521 31.1076 359.097 31.1076C355.918 31.1076 352.72 32.3251 350.211 34.2301L349.975 27.7887ZM358.762 50.1373C361.053 50.1373 362.849 49.1358 364.015 47.5843C365.239 45.9739 365.575 43.9119 365.575 41.6928H362.336C358.979 41.6928 354.002 42.2427 354.002 46.6416C354.002 49.0965 356.077 50.1373 358.762 50.1373ZM75.1056 0H74.9477C74.059 0.0982408 56.0886 1.76747 53.3634 2.63164C52.1589 3.00475 50.2433 4.04555 51.0726 6.87352C51.3492 7.81623 52.534 9.85857 53.6004 11.685C53.7584 11.9599 53.8967 12.1956 53.9756 12.333C56.0886 16.0251 55.4172 18.6566 54.5877 20.542C52.9289 24.3323 49.3152 25.6872 46.4715 25.6872C44.7928 25.6872 43.1341 25.2356 41.8307 24.4304C37.7627 21.897 36.3211 18.3818 37.4073 13.6881C37.9602 11.1547 38.1775 9.32839 38.0589 8.0911C37.9602 7.1484 37.5059 6.42188 36.7556 5.97009C36.1829 5.63624 35.4522 5.45947 34.5438 5.45947C32.7468 5.45947 30.8313 6.14686 30.614 6.2254L16.5932 10.8601C16.0995 11.0172 15.7242 11.3315 15.5071 11.744C15.3688 12.0384 15.2305 12.5098 15.4478 13.1382L19.1801 24.2733C20.0293 26.787 19.7922 27.8672 19.4565 28.3384C19.1801 28.7312 18.6074 28.9277 17.7978 28.9277C17.6003 28.9277 17.4028 28.908 17.1658 28.8883L14.8554 28.6527L10.3727 28.2011C10.0961 28.1814 9.81971 28.1618 9.54317 28.1618C7.07481 28.1618 4.62598 29.3008 2.8092 31.2843C0.795004 33.523 -0.231911 36.626 0.0446332 39.7878C0.459304 44.2458 2.82902 46.7792 4.72476 48.1145C6.97588 49.7052 9.5235 50.2944 11.0046 50.3141H11.1823C13.315 50.3141 15.5466 49.6857 18.2125 48.3306C20.9376 46.9362 22.0435 46.7202 22.4583 46.7202H22.5373C24.0578 46.8774 24.0183 50.0785 24.0183 50.098V50.1373L24.2552 69.1279V69.2065C24.4132 70.4436 25.2822 70.8757 25.993 70.8757H26.151C27.0396 70.7971 45.0101 69.1082 47.7155 68.2638C48.9202 67.8906 50.8357 66.8498 50.0062 64.0219C49.7298 63.0792 48.545 61.0368 47.4786 59.2104C47.3206 58.9354 47.1824 58.6998 47.1034 58.5623C44.9904 54.8703 45.6618 52.2386 46.4911 50.3533C48.15 46.5631 51.7639 45.208 54.6075 45.208C56.286 45.208 57.9449 45.6597 59.2482 46.4649C63.3162 48.9983 64.7578 52.5136 63.6717 57.2072C63.1188 59.7406 62.9015 61.567 63.02 62.8043C63.1188 63.7468 63.5729 64.4735 64.3235 64.9252C64.8961 65.259 65.6268 65.4358 66.5351 65.4358C68.3322 65.4358 70.2477 64.7484 70.465 64.6698L84.4859 60.0351C84.9795 59.8781 85.3547 59.5638 85.5719 59.1514C85.7102 58.8568 85.8485 58.3855 85.6312 57.7571L81.8989 46.6221C81.0497 44.1082 81.2867 43.0282 81.6224 42.5568C81.8989 42.164 82.4715 41.9677 83.2812 41.9677C83.4786 41.9677 83.6762 41.9874 83.9131 42.0069L86.2237 42.2427L90.7064 42.6943C90.9828 42.7139 91.2593 42.7336 91.5357 42.7336C94.0042 42.7336 96.4529 41.5946 98.2697 39.611C100.343 37.3527 101.37 34.2301 101.074 31.0683C100.659 26.6104 98.2895 24.077 96.3937 22.7414C94.1425 21.1508 91.595 20.5616 90.1139 20.542H89.9362C87.8034 20.542 85.5719 21.1705 82.906 22.5254C80.1808 23.9198 79.0749 24.1358 78.6602 24.1358H78.5812C77.0607 23.9787 77.1002 20.7776 77.1002 20.7579V20.7187L76.8434 1.76747V1.68893C76.6855 0.432086 75.8165 0 75.1056 0Z" fill="#032B4C"/>
+<path d="M64.5011 57.4232C64.4221 57.8357 64.3234 58.2284 64.2444 58.6408C65.9624 58.6605 68.5888 58.0321 68.5888 58.0321L64.7973 53.2403C64.9553 54.6149 64.817 56.0289 64.5011 57.4232Z" fill="#032B4C"/>
+<path d="M49.236 64.2969C48.9003 63.1774 46.8859 59.8781 46.3923 59.0141C44.1214 55.0273 44.8717 52.062 45.7406 50.0588C46.0566 49.3323 46.4318 48.7038 46.8663 48.1147C45.2667 42.9694 45.9578 37.3919 45.9578 37.3919C46.2344 41.4178 48.0708 44.4225 49.2162 45.9544C52.435 43.9119 56.7203 43.9709 59.6825 45.8169C62.8422 47.8004 64.3233 50.2356 64.7181 52.8279L72.2816 56.0486L76.7446 49.4696L64.4219 30.9701C63.5136 28.6527 63.8691 25.7855 63.8691 25.7855C63.3951 25.6284 59.0309 23.2915 55.1801 21.2097C52.514 26.7479 45.6024 27.7494 41.3763 25.1178C38.2761 23.1933 36.8147 20.8169 36.3605 18.2835C34.9386 19.0887 33.418 20.1297 31.8382 21.3865C29.4488 18.4015 26.3878 14.1399 23.7021 9.34796L16.8892 11.6065C16.356 11.7833 16.0598 12.2152 16.2771 12.8438C16.2771 12.8438 16.4548 13.3935 16.751 14.2577C20.5623 18.7156 24.7488 22.5451 27.8887 25.1178C26.7235 26.3551 25.5782 27.7297 24.5118 29.2419C23.2076 28.5606 21.9172 27.8535 20.6413 27.121C20.6413 28.7902 19.7922 29.9685 17.1262 29.7132C15.2303 29.5169 11.0044 29.0848 10.333 29.026C9.74054 28.967 9.16778 28.9866 8.59516 29.0652C13.4136 31.2254 18.1728 32.8162 21.7274 33.798C20.9177 35.3495 20.187 36.9991 19.5749 38.747C14.8552 38.4525 7.92376 37.6276 1.28844 35.7227C0.895043 37.0264 0.760924 38.3939 0.893588 39.7486C1.09102 41.9874 1.82172 43.7351 2.809 45.1099C8.57535 45.2474 14.1443 44.7171 18.0938 44.128C17.8568 45.3063 17.6792 46.5238 17.5409 47.7807C17.6397 47.7219 17.7383 47.6826 17.8568 47.6236C19.7527 46.6614 21.6484 45.8562 22.6358 45.9347C25.0056 46.1704 24.8673 50.1767 24.8673 50.1767L25.1042 69.1672C25.2425 70.2277 26.0916 70.1099 26.0916 70.1099C26.0916 70.1099 44.8519 68.362 47.4982 67.5175C49.8679 66.7909 49.4532 65.0431 49.236 64.2969ZM71.0177 49.4696L73.5849 50.157L70.2674 50.7659L68.7665 48.036L71.0177 49.4696ZM58.9914 29.6937L60.8082 31.4219C60.8082 31.4219 58.6557 32.3056 57.7274 31.7164C56.7993 31.1076 55.2985 27.8083 55.2985 27.8083L58.9914 29.6937Z" fill="#032B4C"/>
+<path d="M36.301 17.5963C36.1628 16.2412 36.301 14.8664 36.617 13.4917C37.0515 11.4887 37.3674 9.48545 37.2489 8.15007C36.9725 5.55784 33.4771 6.22553 31.7986 6.69674C33.2204 10.8798 34.8792 14.6897 36.301 17.5963Z" fill="#032B4C"/>
+</g>
+<defs>
+<clipPath id="clip0_1536_519">
+<rect width="373" height="71" fill="white"/>
+</clipPath>
+</defs>
+</svg>
+
+<h1 align="center">
+Liquipedia PHP Client
+</h1>
+<p align="center">
+An unofficial PHP client for the <a href="https://liquipedia.net">Liquipedia</a> API.
+<p>
+
+<p align="center">
+<a href="https://github.com/npldevfr/liquipedia-php-client" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/npldevfr/liquipedia-php-client?flat&colorA=002438&colorB=41c399"></a>
+</p>
+
+
+## 📦 Installation
+Supports PHP >= 8.2
+
+```bash
+composer require npldevfr/liquipedia-php-client
+```
+
+## 🚀 Usage
+```php
+// todo
+```
+
+
+
+
 🧹 Keep a modern codebase with **Pint**:
 ```bash
 composer lint