diff --git a/README.md b/README.md index 494f01b..0c1b26f 100644 --- a/README.md +++ b/README.md @@ -1 +1,29 @@ -# NewRepo \ No newline at end of file +# SPWorldsWrapper +![](https://img.shields.io/badge/dotnet-.NET_8-green) + +Это довольно простой wrapper для работы с сайтом, а не с апи. Он позволяет: +- Находить более расширные данные о пользователь от сайта, нежели стандартные апи. +- Добавлять/удалять города на карте(ПРИ НАЛИЧИИ РОЛИ КАРТОГРАФА) +- Получать любые данные, используя HttpClient, внутри класса + +# Добавление функций +Если вы хотите помочь с разработкой, просьба создать Pull Request, где будет созданы нужные методы и, желательно, комментарии к ним. +Если вы хотите помочь с расширением этого wrapper`a, просьба создать Issue, где вы подробно изложите, что именно вам надо. + +# Использование +## Перевод игроку, имея только никнейм +Ниже есть пример использования. В ходе этого примера мы переводим игроку 1 АР, получая карту по никнейму, а потом переводя на нее ары(через [библиотеку](https://github.com/Mih4n/spworlds-csharp-library)). +```cs +using SPWorldsWrapper; +using SPWorlds; + +// инициилизация конструктора +// Токен надо получать на сайте, либо через cookies, либо через проверку request +SPWrapper wrapper = new SPWrapper ("AaBbCcDd:123123123"); +// использование сторонней библиотеки от Mih4n +SPWorlds sp = new SPworlds("[ваш айди]","[ваш токен]"); + +// Пример, перевод на карту игрока по никнейму: +SPUser user = await wrapper.getUserData("yawaflua"); +sp.CreateTransaction(user.CardsOwned.First().number, 1, "Привет от yawaflua") +```