Skip to content

Commit d1e94ba

Browse files
committed
Add usage example to README
1 parent 2d95dd1 commit d1e94ba

1 file changed

Lines changed: 25 additions & 0 deletions

File tree

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,28 @@ A C# wrapper for Derpibooru JSON models
77
**Build** | TBD
88
**NuGet** | [![nuget](https://img.shields.io/nuget/v/Nullforce.Api.Derpibooru.JsonModels.svg)](https://www.nuget.org/packages/Nullforce.Api.Derpibooru.JsonModels/)
99
**NuGet (prerelease)**| [![nuget](https://img.shields.io/nuget/vpre/Nullforce.Api.Derpibooru.JsonModels.svg)](https://www.nuget.org/packages/Nullforce.Api.Derpibooru.JsonModels/)
10+
11+
12+
## Usage Example
13+
14+
An example using [Flurl.Http](https://flurl.dev/):
15+
16+
Install the `Nullforce.Api.Derpibooru.JsonModels` package from NuGet (allow prerelease as needed).
17+
18+
```csharp
19+
using Flurl;
20+
using Flurl.Http;
21+
using Nullforce.Api.Derpibooru.JsonModels;
22+
23+
...
24+
25+
var uri = "https://derpibooru.org/search.json";
26+
uri = uri.SetQueryParam("q", "fluttershy");
27+
28+
var searchResult = await uri.GetJsonAsync<SearchRootJson>();
29+
```
30+
31+
## See Also
32+
33+
If you're looking for a Derpibooru client written in C# that uses these models,
34+
see [Nullforce.Api.Derpibooru](https://github.com/nullforce-public/Nullforce.Api.Derpibooru)

0 commit comments

Comments
 (0)