prep for release

jtwotimes · Nov 20, 2023 · f03a131 · f03a131
1 parent 6555401
commit f03a131
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 11 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,31 +1,39 @@
 # Changelog
 
+## 4.0.0
+### Breaking Changes
+- Switched from Newtonsoft.Json to System.Text.Json for serialization
+
+### Added
+- `IAsyncEnumerable` support for paging available in methods `GetAllNamedResourcesAsync<T>` and `GetAllApiResourcesAsync<T>`
+- Updated `Move` model to include new property: `learned_by_pokemon`: [#43](https://github.com/jtwotimes/PokeApiNet/pull/43)
+
 ## 3.0.10
 ### Added
-- Updated `Pokemon` model to include new property: `front_shiny`: [#41](https://github.com/mtrdp642/PokeApiNet/pull/41)
+- Updated `Pokemon` model to include new property: `front_shiny`: [#41](https://github.com/jtwotimes/PokeApiNet/pull/41)
 
 ## 3.0.9
 ### Fix
- - Add support for endpoints respecting case sensitivity for named parameters: [#39](https://github.com/mtrdp642/PokeApiNet/pull/39)
+ - Add support for endpoints respecting case sensitivity for named parameters: [#39](https://github.com/jtwotimes/PokeApiNet/pull/39)
 
 ## 3.0.8
 ### Added
 - Made property `PokemonSpecies.CaptureRate` and `PokemonSpecies.BaseHappiness` nullable
 
 ## 3.0.7
 ### Added
-- Made property `Pokemon.BaseExperience` nullable: [#37](https://github.com/mtrdp642/PokeApiNet/pull/37)
+- Made property `Pokemon.BaseExperience` nullable: [#37](https://github.com/jtwotimes/PokeApiNet/pull/37)
 
 ## 3.0.6
 This is the same release as 3.0.5. Use 3.0.7 instead.
 
 ## 3.0.5
 ### Added
-- Updated `Pokemon` model to include new properties for historical and alternate form sprites: [#33](https://github.com/mtrdp642/PokeApiNet/pull/33)
+- Updated `Pokemon` model to include new properties for historical and alternate form sprites: [#33](https://github.com/jtwotimes/PokeApiNet/pull/33)
 
 ## 3.0.4
 ### Fix
-- Ensure HTTP responses are only processed after the content of the request has been read, instead of just the headers: [#29](https://github.com/mtrdp642/PokeApiNet/issues/29)
+- Ensure HTTP responses are only processed after the content of the request has been read, instead of just the headers: [#29](https://github.com/jtwotimes/PokeApiNet/issues/29)
 - Updated dependencies
 - Bump test project to .Net 6.0
 
@@ -60,5 +68,5 @@ This is the same release as 3.0.5. Use 3.0.7 instead.
 - Stricter constraints on type parameters for `PokeApiClient.GetResourceAsync<T>(string)` and `PokeApiClient.GetResourceAsync<T>(string, CancellationToken)`
 
 ### Added
-- Resource lists are now cached automatically (closes [#10](https://github.com/mtrdp642/PokeApiNet/issues/10))
+- Resource lists are now cached automatically (closes [#10](https://github.com/jtwotimes/PokeApiNet/issues/10))
 - Resource list caches can be cleared via `PokeApiClient.ClearResourceListCache` and typed overload for more granular clearing
diff --git a/LICENSE.md b/LICENSE.md
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 JJ Banda
+Copyright (c) 2023 JJ Banda
 
 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/PokeApiNet/PokeApiNet.csproj b/PokeApiNet/PokeApiNet.csproj
@@ -4,13 +4,13 @@
     <TargetFrameworks>netstandard2.0;netstandard2.1</TargetFrameworks>
     <Authors>JJ Banda</Authors>
     <Description>.Net client for the PokeAPI api</Description>
-    <PackageProjectUrl>https://github.com/mtrdp642/PokeApiNet</PackageProjectUrl>
-    <RepositoryUrl>https://github.com/mtrdp642/PokeApiNet</RepositoryUrl>
+    <PackageProjectUrl>https://github.com/jtwotimes/PokeApiNet</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/jtwotimes/PokeApiNet</RepositoryUrl>
     <PackageTags>pokemon pokeapi</PackageTags>
-    <PackageReleaseNotes>https://github.com/mtrdp642/PokeApiNet/blob/master/CHANGELOG.md</PackageReleaseNotes>
+    <PackageReleaseNotes>https://github.com/jtwotimes/PokeApiNet/blob/master/CHANGELOG.md</PackageReleaseNotes>
     <PackageRequireLicenseAcceptance>false</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <LangVersion>11</LangVersion>
+    <LangVersion>11.0</LangVersion>
     <Nullable>enable</Nullable>
   </PropertyGroup>
 

diff --git a/README.md b/README.md
@@ -65,6 +65,16 @@ Berry cheri = await client.GetResourceAsync<Berry>(firstBerryPage.Results[0]);
 
 Refer to the PokeAPI documention to see which resources include a `Name` property.
 
+### `IAsyncEnumerable` Support
+Two methods expose support for `IAsyncEnumerable` to make paging through all pages super simple: `GetAllNamedResourcesAsync<T>()` and `GetAllApiResourcesAsync<T>()`. Example:
+
+```cs
+await foreach (var berryRef in pokeClient.GetAllNamedResourcesAsync<Berry>())
+{
+    // do something with each berry reference
+}
+```
+
 ## Caching
 Every resource and page response is automatically cached in memory, making all subsequent requests for the same resource or page pull cached data. Example:
 ```cs