Skip to content

Commit

Permalink
- Upgraded project to .NET 8
Browse files Browse the repository at this point in the history
- Updated links to documentation
  • Loading branch information
markjamesm committed Dec 2, 2023
1 parent a79ea85 commit 523f7e5
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 17 deletions.
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

## About

Baseball Sharp is an unofficial .NET API client for accessing the public facing (but undocumented) MLB Stats API. Currently runs on .NET 7.
Baseball Sharp is an unofficial .NET API client for accessing the public facing (but undocumented) MLB (Major League Baseball) Stats API. Currently runs on .NET 8.

## Usage

Expand All @@ -27,7 +27,6 @@ The solution contains two projects:

* Continue implementing API endpoints and helper functions.
* Add unit tests.
* Develop BaseballSharp CLI example to showcase usage.

## Copyright Notice

Expand Down
8 changes: 4 additions & 4 deletions docfx/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ Browse the API documentation.

## Namespaces

- The [BaseballSharp namespace](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.html) contains the classes used to interface with the MLB Stats Api, as well as associated helper types:
- The [Api class](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.Api.html) holds all MLB Stats API endpoints that can be accessed from Baseball Sharp.
- The [eTeamId enum](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.eTeamId.html) contains handy references to all team ids (team ids are used as parameters for certain API calls).
- The [BaseballSharp namespace](https://baseballsharp.markjames.dev/api/BaseballSharp.html) contains the classes used to interface with the MLB Stats Api, as well as associated helper types:
- The [Api class](https://markjames.dev/api/BaseballSharp.Api.html) holds all MLB Stats API endpoints that can be accessed from Baseball Sharp.
- The [eTeamId enum](https://baseballsharp.markjames.dev/api/BaseballSharp.eTeamId.html) contains handy references to all team ids (team ids are used as parameters for certain API calls).

- [BaseballSharp.Models](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.Models.html) contains the deserialized JSON responses from the Stats API, as well as their associated properties. These are the model classes that the functions in the [Api class](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.Api.html) return.
- [BaseballSharp.Models](https://baseballsharp.markjames.dev/api/BaseballSharp.Models.html) contains the deserialized JSON responses from the Stats API, as well as their associated properties. These are the model classes that the functions in the [Api class](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.Api.html) return.

### Copyright Notice
This package and its author are not affiliated with MLB or any MLB team. This API wrapper interfaces with MLB's Stats API. Use of MLB data is subject to the notice posted at http://gdx.mlb.com/components/copyright.txt.
6 changes: 6 additions & 0 deletions docfx/articles/changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

#### 0.2.0

- Expanded json serializer option to make deserialization less sensitive for malformed json.
- Improved error handling.
- Updated project to .NET 8.

#### 0.1.9

- Major code cleanup and refactoring.
Expand Down
2 changes: 1 addition & 1 deletion docfx/articles/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ using BaseballSharp;

## Endpoints

- Visit the [API Reference section](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.html) for the most up-to-date endpoint and model documentation.
- Visit the [API Reference section](https://baseballsharp.markjames.dev/api/BaseballSharp.html) for the most up-to-date endpoint and model documentation.

- You can also see examples of how to use the endpoint functions in the [BaseballSharpCli example app](https://github.com/markjamesm/Baseball-Sharp/blob/master/samples/BaseballSharpCli/Program.cs).

Expand Down
4 changes: 2 additions & 2 deletions docfx/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Baseball Sharp

This is the documentation website for [Baseball Sharp](https://github.com/markjamesm/Baseball-Sharp), an unofficial .NET wrapper library for the public facing (but undocumented) MLB Stats API. Currently in an early alpha status, Baseball Sharp is in active development and is built on .NET 5.0.
This is the documentation website for [Baseball Sharp](https://github.com/markjamesm/BaseballSharp), an unofficial .NET wrapper library for the public facing (but undocumented) MLB (Major League Baseball) Stats API.

* [Nuget Package](https://www.nuget.org/packages/BaseballSharp).

## Quick Start Notes:

Check out the [getting started guide](https://markjames.dev/Baseball-Sharp/articles/intro.html) or dive into the [API Documentation](https://markjames.dev/Baseball-Sharp/api/BaseballSharp.html).
Check out the [getting started guide](https://baseballsharp.markjames.dev/articles/intro.html) or dive into the [API Documentation](https://baseballsharp.markjames.dev/api/BaseballSharp.html).


## Copyright Notice
Expand Down
2 changes: 1 addition & 1 deletion samples/BaseballSharpCli/BaseballSharpCli.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<PropertyGroup>
<OutputType>Exe</OutputType>
<TargetFramework>net7.0</TargetFramework>
<TargetFramework>net8.0</TargetFramework>
</PropertyGroup>

<ItemGroup>
Expand Down
14 changes: 7 additions & 7 deletions src/BaseballSharp.csproj
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net7.0</TargetFramework>
<TargetFramework>net8.0</TargetFramework>
<GenerateRuntimeConfigurationFiles>true</GenerateRuntimeConfigurationFiles>
<Version>0.2.0</Version>
<Authors>Mark-James McDougall</Authors>
<Product>BaseballSharp</Product>
<Title>Baseball Sharp</Title>
<Title>BaseballSharp</Title>
<Description>
Baseball Sharp is an unofficial .NET wrapper for the MLB Stats API.
View the documentation - https://markjames.dev/Baseball-Sharp/articles/intro.html
Changelog - https://markjames.dev/Baseball-Sharp/articles/changelog.html
BaseballSharp is an unofficial .NET wrapper for the MLB Stats API.
View the documentation - https://baseballsharp.markjames.dev/articles/intro.html
Changelog - https://baseballsharp.markjames.dev/articles/changelog.html
This package and its author are not affiliated with MLB or any MLB team. This API wrapper interfaces with MLB's Stats API. Use of MLB data is subject to the notice posted at http://gdx.mlb.com/components/copyright.txt.
</Description>
<RepositoryUrl>https://github.com/markjamesm/Baseball-Sharp</RepositoryUrl>
<PackageTags>MLB, Baseball, Wrapper</PackageTags>
<RepositoryUrl>https://github.com/markjamesm/BaseballSharp</RepositoryUrl>
<PackageTags>MLB, Baseball, Major League Baseball, MLB API</PackageTags>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageId>BaseballSharp</PackageId>
<Configuration>release</Configuration>
Expand Down

0 comments on commit 523f7e5

Please sign in to comment.