From 73201d8aa6d13d43b758500914e778958eae762b Mon Sep 17 00:00:00 2001 From: bsdayo Date: Fri, 5 May 2023 23:00:31 +0800 Subject: [PATCH] docs: update readme --- README.md | 62 ++++++++++++++++++++++++++----------------------------- 1 file changed, 29 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index f06b677..68edd12 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,35 @@ -# ArcaeaUnlimitedAPI.Lib +# UnofficialArcaeaAPI.Lib -[![NuGet](https://img.shields.io/nuget/vpre/ArcaeaUnlimitedAPI.Lib?label=NuGet)](https://www.nuget.org/packages/ArcaeaUnlimitedAPI.Lib/) +[![NuGet](https://img.shields.io/nuget/vpre/UnofficialArcaeaAPI.Lib?label=NuGet)](https://www.nuget.org/packages/UnofficialArcaeaAPI.Lib/) -A wrapper for ArcaeaUnlimitedAPI with C#. +A wrapper for UnofficialArcaeaAPI with C#. ## Install ```shell -dotnet add package ArcaeaUnlimitedAPI.Lib +dotnet add package UnofficialArcaeaAPI.Lib ``` ## Usage ```csharp -using ArcaeaUnlimitedAPI.Lib; -using ArcaeaUnlimitedAPI.Lib.Models; +using UnofficialArcaeaAPI.Lib; +using UnofficialArcaeaAPI.Lib.Models; -var client = new AuaClient +var client = new UaaClient(new UaaClientOptions { ApiUrl = "", Token = "", // Or if you want UserAgent = "" -}.Initialize(); - -// Query best 30 of Nagiha0798 -var best30 = await client.User.Best30("Nagiha0798", - 10, // Overflow count - AuaReplyWith.SongInfo); // Reply with songinfo - -Console.WriteLine(best30.AccountInfo.Rating); -Console.WriteLine(best30.Best30List[0].SongId); +}); +// Query bests session of Nagiha0798 +var best30 = await client.User.GetBestsSessionAsync("Nagiha0798"); // Query songinfo of #1f1e33 -var songinfo = await client.Song.Info("ifi", AuaSongQueryType.SongId); +var songinfo = await client.Song.GetInfoAsync("ifi", AuaSongQueryType.SongId); Console.WriteLine(songinfo.SongId); Console.WriteLine(songinfo.Difficulties[2].NameEn); @@ -43,22 +37,24 @@ Console.WriteLine(songinfo.Difficulties[2].NameEn); ## Supported endpoints -- [x] [user/info](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/user/info.md) -- [x] [user/best](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/user/best.md) -- [x] [user/best30](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/user/best30.md) -- [x] [song/info](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/song/info.md) -- [x] [song/list](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/song/list.md) -- [x] [song/alias](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/song/alias.md) -- [x] [song/random](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/song/random.md) -- [x] [assets/icon](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/assets/icon.md) -- [x] [assets/char](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/assets/char.md) -- [x] [assets/song](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/assets/song.md) -- [x] [assets/preview](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/assets/preview.md) -- [x] [data/update](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/data/update.md) -- [x] [data/theory](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/data/theory.md) -- [x] [data/playdata](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/data/playdata.md) -- [x] [data/density](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/data/density.md) -- [x] [data/challenge](https://github.com/Arcaea-Infinity/ArcaeaUnlimitedAPI-Wiki/blob/main/data/challenge.md) +- [x] [user/info](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/user/info.md) +- [x] [user/best](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/user/best.md) +- [x] [user/bests/session](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/user/bests/session.md) +- [x] [user/bests/result](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/user/bests/result.md) +- [x] [song/info](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/song/info.md) +- [x] [song/list](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/song/list.md) +- [x] [song/alias](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/song/alias.md) +- [x] [song/random](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/song/random.md) +- [x] [assets/icon](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/assets/icon.md) +- [x] [assets/char](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/assets/char.md) +- [x] [assets/song](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/assets/song.md) +- [x] [assets/aff](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/assets/aff.md) +- [x] [assets/preview](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/assets/preview.md) +- [x] [data/update](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/data/update.md) +- [x] [data/theory](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/data/theory.md) +- [x] [data/challenge](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/data/challenge.md) +- [x] [data/cert](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/data/cert.md) +- [ ] [image/user/*](https://github.com/Arcaea-Infinity/UnofficialArcaeaAPI.Docs/blob/main/image/user.md) ## License