Merge changes (#6)

Merge changes
Vasar007 · Jan 4, 2020 · 5390606 · 5390606
2 parents f132b8f + db3f6da
commit 5390606
Show file tree

Hide file tree

Showing 5 changed files with 65 additions and 33 deletions.
diff --git a/README.md b/README.md
@@ -8,6 +8,10 @@ SteamWepApiLib is a .NET wrapper for the Steam API. It provides a set of methods
 
 The Steam API is not officially available or documented. So, all data in this library was either collected by trial and error from unofficial API documentation, and is therefore provided as-is.
 
+## Installation
+
+Install [NuGet package](https://www.nuget.org/packages/SteamWebApiLib).
+
 ## Usage examples
 
 ```cs
@@ -26,7 +30,7 @@ private static async Task Examples()
 
     // Get full list of SteamApps.
     SteamAppBriefInfoList steamAppList = await steamApiClient.GetAppListAsync();
-    Console.WriteLine($"Got {steamAppList.Apps.Length} items.");
+    Console.WriteLine($"Got {steamAppList.Apps.Length.ToString()} items.");
 
     // Get details for SteamApp with ID 292030 (The Witcher 3: Wild Hunt).
     SteamApp steamApp1 = await steamApiClient.GetSteamAppAsync(292030);
@@ -42,23 +46,23 @@ private static async Task Examples()
 
     // Get details for Package with same ID for region JP.
     PackageInfo package2 = await steamApiClient.GetPackageInfoAsync(68179, CountryCode.Japan);
-    Console.WriteLine($"Got response for {package1.Name}.");
+    Console.WriteLine($"Got response for {package2.Name}.");
 
     // Get a list of featured games.
     FeaturedApps featured1 = await steamApiClient.GetFeaturedAppsAsync();
-    Console.WriteLine($"Got {featured1.FeaturedWin.Length} items for Winodws.");
+    Console.WriteLine($"Got {featured1.FeaturedWin.Length.ToString()} items for Windows.");
 
     // Get a list of featured games for region DE.
     FeaturedApps featured2 = await steamApiClient.GetFeaturedAppsAsync(CountryCode.Germany);
-    Console.WriteLine($"Got {featured2.FeaturedWin.Length} items for Winodws.");
+    Console.WriteLine($"Got {featured2.FeaturedWin.Length.ToString()} items for Windows.");
 
     // Get a list of featured games grouped by category.
     FeaturedCategories featuredCategories1 = await steamApiClient.GetFeaturedCategoriesAsync();
-    Console.WriteLine($"Got {featuredCategories1.TopSellers.Items.Length} top sellers items.");
+    Console.WriteLine($"Got {featuredCategories1.TopSellers.Items.Length.ToString()} top sellers items.");
 
     // Get a list of featured games grouped by category for region US.
     FeaturedCategories featuredCategories2 = await steamApiClient.GetFeaturedCategoriesAsync(CountryCode.USA);
-    Console.WriteLine($"Got {featuredCategories2.TopSellers.Items.Length} top sellers items.");
+    Console.WriteLine($"Got {featuredCategories2.TopSellers.Items.Length.ToString()} top sellers items.");
 }
 ```
 
@@ -81,8 +85,8 @@ This project is licensed under the terms of the [Apache License 2.0](LICENSE).
 
 ### Third party software and libraries used
 
-Newtonsoft.Json https://www.newtonsoft.com/json
+#### [Newtonsoft.Json](https://github.com/JamesNK/Newtonsoft.Json)
 
-Copyright (c) 2007 James Newton-King
+Copyright © 2007 James Newton-King
 
-License (MIT) https://raw.githubusercontent.com/JamesNK/Newtonsoft.Json/master/LICENSE.md
+License: [MIT](https://github.com/JamesNK/Newtonsoft.Json/blob/master/LICENSE.md)
diff --git a/SteamWebApiLib/SteamWebApiLib.csproj b/SteamWebApiLib/SteamWebApiLib.csproj
@@ -19,11 +19,15 @@ The Steam API is not officially available or documented. So, all data in this li
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
     <PackageProjectUrl>https://github.com/Vasar007/SteamWebApiLib</PackageProjectUrl>
     <RepositoryType>git</RepositoryType>
+    <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
+    <Copyright>Copyright © 2019 Vasily Vasilyev ([email protected])</Copyright>
+    <ApplicationIcon></ApplicationIcon>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|AnyCPU'">
+  <PropertyGroup Condition="'$(Configuration)'=='Release'">
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
+    <NoWarn>1701;1702;CS1591</NoWarn>
   </PropertyGroup>
 
   <ItemGroup>

diff --git a/SteamWebApiLib/SteamWebApiLib.nuspec b/SteamWebApiLib/SteamWebApiLib.nuspec
@@ -10,7 +10,7 @@
     <projectUrl>$projectUrl$</projectUrl>
     <repositoryUrl>$repositoryUrl$</repositoryUrl>
     <repositoryType>$repositoryType$</repositoryType>
-    <requireLicenseAcceptance>true</requireLicenseAcceptance>
+    <requireLicenseAcceptance>$requireLicenseAcceptance$</requireLicenseAcceptance>
     <description>$description$</description>
     <copyright>$copyright$</copyright>
     <tags>$tags$</tags>

diff --git a/SteamWebApiLibConsoleApp/Program.cs b/SteamWebApiLibConsoleApp/Program.cs
@@ -11,17 +11,30 @@ namespace SteamWebApiLibConsoleApp
 {
     internal static class Program
     {
-        private static async Task Main()
+        private static async Task<int> Main()
         {
             try
             {
+                Console.WriteLine("Console application started.");
+
                 await Examples();
+
+                return 0;
             }
             catch (Exception ex)
             {
-                Console.WriteLine(ex);
+                string exceptionMessage = $"Exception occurred in {nameof(Main)} method. " +
+                                          $"{Environment.NewLine}{ex.ToString()}";
+                Console.WriteLine(exceptionMessage);
+
+                return -1;
+            }
+            finally
+            {
+                Console.WriteLine("Console application stopped.");
+                Console.WriteLine("Press any key to close this window...");
+                Console.ReadKey();
             }
-            Console.ReadLine();
         }
 
         private static async Task Examples()
@@ -30,7 +43,7 @@ private static async Task Examples()
 
             // Get full list of SteamApps.
             SteamAppBriefInfoList steamAppList = await steamApiClient.GetAppListAsync();
-            Console.WriteLine($"Got {steamAppList.Apps.Length} items.");
+            Console.WriteLine($"Got {steamAppList.Apps.Length.ToString()} items.");
 
             // Get details for SteamApp with ID 292030 (The Witcher 3: Wild Hunt).
             SteamApp steamApp1 = await steamApiClient.GetSteamAppAsync(292030);
@@ -46,23 +59,23 @@ private static async Task Examples()
 
             // Get details for Package with same ID for region JP.
             PackageInfo package2 = await steamApiClient.GetPackageInfoAsync(68179, CountryCode.Japan);
-            Console.WriteLine($"Got response for {package1.Name}.");
+            Console.WriteLine($"Got response for {package2.Name}.");
 
             // Get a list of featured games.
             FeaturedApps featured1 = await steamApiClient.GetFeaturedAppsAsync();
-            Console.WriteLine($"Got {featured1.FeaturedWin.Length} items for Winodws.");
+            Console.WriteLine($"Got {featured1.FeaturedWin.Length.ToString()} items for Windows.");
 
             // Get a list of featured games for region DE.
             FeaturedApps featured2 = await steamApiClient.GetFeaturedAppsAsync(CountryCode.Germany);
-            Console.WriteLine($"Got {featured2.FeaturedWin.Length} items for Winodws.");
+            Console.WriteLine($"Got {featured2.FeaturedWin.Length.ToString()} items for Windows.");
 
             // Get a list of featured games grouped by category.
             FeaturedCategories featuredCategories1 = await steamApiClient.GetFeaturedCategoriesAsync();
-            Console.WriteLine($"Got {featuredCategories1.TopSellers.Items.Length} top sellers items.");
+            Console.WriteLine($"Got {featuredCategories1.TopSellers.Items.Length.ToString()} top sellers items.");
 
             // Get a list of featured games grouped by category for region US.
             FeaturedCategories featuredCategories2 = await steamApiClient.GetFeaturedCategoriesAsync(CountryCode.USA);
-            Console.WriteLine($"Got {featuredCategories2.TopSellers.Items.Length} top sellers items.");
+            Console.WriteLine($"Got {featuredCategories2.TopSellers.Items.Length.ToString()} top sellers items.");
         }
     }
 }
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,29 +1,40 @@
 version: '{build}'
 image: Visual Studio 2017
 
-pull_requests:
-    do_not_increment_build_number: true
-
 branches:  
-    only:
+  only:
     - master
     - develop
 
-nuget:  
-    disable_publish_on_pr: true
+configuration:
+  - Debug
+  - Release
+
+matrix:
+  fast_finish: true
 
 before_build:
-- cmd: dotnet restore
+  - cmd: dotnet restore
+
+build:
+  verbosity: minimal
 
 after_build:
-- dotnet test
-- dotnet pack "SteamWebApiLib" -c Release
+  - dotnet test
+  - dotnet pack "SteamWebApiLib" -c Release
 
 artifacts:
-- path: SteamWebApiLib\bin\Release\*.nupkg
+  - path: SteamWebApiLib\bin\Release\*.nupkg
 
 deploy:  
-- provider: Environment
-  name: nuget.org
-  on:
+  - provider: Environment
+    name: SteamWebApiLib
+    on:
       branch: master
+      configuration: Release
+
+pull_requests:
+    do_not_increment_build_number: true
+
+nuget:
+    disable_publish_on_pr: true