Skip to content

Commit bd29f9a

Browse files
author
Justin Skiles
authored
Update README.md
1 parent 9caf7aa commit bd29f9a

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

README.md

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,12 +24,18 @@ Instead of stressing about parsing the ugly JSON responses yourself, just use th
2424
* Handles legacy, modern, and 64-bit Steam Id representations
2525

2626
## Install the Library from NuGet
27-
See the library in the NuGet gallery [here](https://www.nuget.org/packages/SteamWebAPI2). You can install the library into your project directly from the package manager.
27+
See the library in the NuGet gallery [here](https://www.nuget.org/packages/SteamWebAPI2).
2828

29+
Package Manager:
2930
```
3031
Install-Package SteamWebAPI2
3132
```
3233

34+
.NET Core CLI:
35+
```
36+
dotnet add package SteamWebAPI2
37+
```
38+
3339
## How to Use the Library
3440
1. Read the `About` section so you understand why this library exists
3541
2. Install the library from NuGet
@@ -38,7 +44,7 @@ Install-Package SteamWebAPI2
3844
5. Use the factory to create endpoint interface classes.
3945
5. Use the interface class and call a method with your parameters.
4046

41-
The library is structured to mirror the Steam Web API endpoint structure. For example, the "DOTA2Econ" class will expose methods to communicate with the "IDOTA2Econ" endpoints.
47+
The library is structured to mirror the Steam Web API endpoint structure. For example, the "DOTA2Econ" class will expose methods to communicate with the "IDOTA2Econ" endpoints. See [here](http://steamwebapi.azurewebsites.net/) for more endpoint details.
4248

4349
Each method returns a SteamWebResponse object which contains the following:
4450

@@ -72,10 +78,3 @@ var playerSummaryLastModified = playerSummaryResponse.LastModified;
7278
var friendsListResponse = await steamInterface.GetFriendsListAsync(<steamIdHere>);
7379
var friendsList = friendsListResponse.Data;
7480
```
75-
76-
## Changes from 2.0 to 3.0
77-
In versions previous to 3.0, numerical types were treated as short, int, and long. This caused problems when interacting with the Steam Web API because Valve accepts and returns unsigned numerical types. Instead of constantly reacting to overflows when a specific endpoint would return something outside the bounds of a 32-bit int, I decided to switch all numerical types to their unsigned counterparts.
78-
79-
## Changes from 3.0 to 4.0
80-
* .NET Core is now supported.
81-
* All endpoints now return ISteamWebResponse<T> where T is the response payload type. This allows more metadata to be returned with each end point such as HTTP headers and status messages in addition to the response payload.

0 commit comments

Comments
 (0)