Skip to content

Commit

Permalink
Change SK2 to SK in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
xPaw committed Nov 7, 2024
1 parent 7b8380d commit 0c4db89
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/steamkit2-build.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ on:

jobs:
steamkit2:
name: SteamKit2 on ${{ matrix.os }} - ${{ matrix.configuration }} (SDK ${{ matrix.sdk }})
name: SteamKit on ${{ matrix.os }} - ${{ matrix.configuration }} (SDK ${{ matrix.sdk }})

strategy:
matrix:
Expand All @@ -29,7 +29,7 @@ jobs:
with:
dotnet-version: ${{ matrix.sdk }}

- name: Build SteamKit2
- name: Build SteamKit
run: dotnet build --configuration ${{ matrix.configuration }} SteamKit2/SteamKit2/SteamKit2.csproj

- name: Build SteamLanguageParser
Expand Down
18 changes: 9 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
# SteamKit2
# SteamKit
[![Build Status (CI/CD)](https://github.com/SteamRE/SteamKit/workflows/CI/CD/badge.svg?branch=master&event=push)](https://github.com/SteamRE/SteamKit/actions?query=workflow%3ACI%2FCD)
[![NuGet](https://img.shields.io/nuget/v/SteamKit2.svg)](https://www.nuget.org/packages/SteamKit2/)
[![codecov](https://codecov.io/gh/SteamRE/SteamKit/branch/master/graph/badge.svg?token=qkJCxZI6rd)](https://codecov.io/gh/SteamRE/SteamKit)

SteamKit2 is a .NET library designed to interoperate with Valve's [Steam network](https://store.steampowered.com/about). It aims to provide a simple, yet extensible, interface to perform various actions on the network.
SteamKit *(also known as SteamKit2)* is a .NET library designed to interoperate with Valve's [Steam network](https://store.steampowered.com/about). It aims to provide a simple, yet extensible, interface to perform various actions on the network.


## Getting Binaries


### Visual Studio

SteamKit2 is distributed as a [NuGet package](https://www.nuget.org/packages/steamkit2).
SteamKit is distributed as a [NuGet package](https://www.nuget.org/packages/steamkit2).

Simply install SteamKit2 using the package manager in Visual Studio, and NuGet will add all the required dependencies and references to your project.
Simply install SteamKit using the package manager in Visual Studio, and NuGet will add all the required dependencies and references to your project.

### Other

We additionally distribute binaries on our [releases page](https://github.com/SteamRE/SteamKit/releases).

For more information on installing SteamKit2, please refer to the [Installation Guide](https://github.com/SteamRE/SteamKit/wiki/Installation) on the wiki.
For more information on installing SteamKit, please refer to the [Installation Guide](https://github.com/SteamRE/SteamKit/wiki/Installation) on the wiki.


## Documentation
Expand All @@ -29,16 +29,16 @@ Documentation consists primarily of XML code documentation provided with the bin

## License

SteamKit2 is released under the [LGPL-2.1 license](https://choosealicense.com/licenses/lgpl-2.1/).
SteamKit is released under the [LGPL-2.1 license](https://choosealicense.com/licenses/lgpl-2.1/).


## Dependencies

In order to use SteamKit2 at runtime, [.NET 8.0 Runtime](https://dot.net/) or higher is required.
In order to use SteamKit at runtime, [.NET 8.0 Runtime](https://dot.net/) or higher is required.

If you're using the SteamKit2 NuGet package, dependencies should be resolved for you. See the [Installation Guide](https://github.com/SteamRE/SteamKit/wiki/Installation) for more information.
If you're using the SteamKit NuGet package, dependencies should be resolved for you. See the [Installation Guide](https://github.com/SteamRE/SteamKit/wiki/Installation) for more information.

To compile SteamKit2, [.NET 8.0 SDK](https://dot.net/) is required.
To compile SteamKit, [.NET 8.0 SDK](https://dot.net/) is required.

## Discussions

Expand Down

0 comments on commit 0c4db89

Please sign in to comment.