diff --git a/README.md b/README.md index ed0c91d..f71ffa7 100644 --- a/README.md +++ b/README.md @@ -1,44 +1,30 @@

- Баннер + Баннер

-**

Русская версия | Example | Discord

** +____ +Баннер[Баннер](https://pypi.org/project/enkacard/) [Баннер](https://discord.gg/shRUCDt4)[Баннер](https://github.com/DEViantUA/EnkaCard)[Баннер](https://enka.network/) +____ -# EnkaNetworkCard -Wrapper for [EnkaNetwork.py](https://github.com/mrwan200/EnkaNetwork.py) to create character cards in Python. +## EnkaCard +An asynchronous module and API that allows you to connect to your bot the generation of Genshin character cards from the Enka.Network website.

+:white_medium_square: 5 templates to choose from.
+:white_medium_square: 2 profile templates.
+:white_medium_square: Customization of all cards with background adaptation. ## Full Documentation: - -EN: - - [Documentation EnkanetworkCard](https://deviantua.github.io/EnkaNetworkCard-Documentation/) - - [API](https://deviantua.github.io/EnkaNetworkCard-Documentation/async/Other/api/) - -## Navigation -* Installation -* Dependencies -* Launch -* Languages Supported -* Sample Results + - [Documentation EnkaCard](https://deviantua.github.io/EnkaCard-Documentation/) + - [API](https://deviantua.github.io/EnkaCard-Documentation/async/Other/api/) + - [Little Kazuha](https://discord.gg/TwuBfDbE) - Discord Bot, which perfectly demonstrates the work of the module. Just use the ```/profile``` command ## Installation: ``` -pip install aioenkanetworkcard +pip install enkacard ``` -### Dependencies: - Dependencies that must be installed for the library to work: - * Pillow - * requests - * io - * math - * datetime - * random - * enkanetwork - * logging - ## Launch: ``` python -from aioenkanetworkcard import encbanner +from enkacard import encbanner import asyncio async def card(): @@ -51,36 +37,61 @@ result = asyncio.run(card()) print(result) ``` ## Languages Supported -| Languege | Code | Languege | Code | -|-------------|---------|-------------|---------| -| English | en | русский | ru | -| Tiếng Việt | vi | ไทย | th | -| português | pt | 한국어 | kr | -| 日本語 | jp | 中文 | zh | -| 中文 | zh | Indonesian | id | -| français | fr | español | es | -| deutsch | de | Taiwan | cht | -| Chinese | chs | | | - -## Sample Results: - +| Languege | Code | Languege | Code | Languege | Code | +|-------------|---------|-------------|---------|-------------|---------| +| English | en | русский | ru | Chinese | chs | +| Tiếng Việt | vi | ไทย | th | Taiwan | cht | +| português | pt | 한국어 | kr | deutsch | de | +| 日本語 | jp | 中文 | zh | español | es | +| 中文 | zh | Indonesian | id | français | fr | -### The result of a custom images and adaptation (template= 1). -Example1 Example2 -### Usual result (template= 1). -Example3 Example4 - -### The result of a custom images and adaptation (template= 2). -namecard = True namecard = False - -### Usual result (template= 2). -namecard = True namecard = False - - -### Usual result (template= 3). -namecard = True namecard = False - -### Usual result (template= 4). -MINI_VERSIA = True -MAX_VERSIA = False +## Sample Results: +
+Sample 1 template + +[![Adaptation][1]][1] + +[1]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/7.png?raw=true + +[![Without Adaptation][2]][2] + +[2]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/6.png?raw=true +
+ + +
+Sample 2 template + +[![Adaptation][3]][3] + +[3]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/4.png?raw=true + +
+ + +
+Sample 3 template + +[![Adaptation][4]][4] + +[4]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/5.png?raw=true + +
+ +
+Sample 4 template + +[![Without Adaptation MINI INFO][5]][5] + +[5]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/1.png?raw=true + +[![Without Adaptation FULL INFO][6]][6] + +[6]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/2.png?raw=true + +[![Adaptation MINI INFO][7]][7] + +[7]: https://github.com/DEViantUA/EnkaCard/blob/main/readmeFile/3.png?raw=true + +