diff --git a/docs/docfx.json b/docs/docfx.json index 2d0b9a4..f6db207 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -36,8 +36,8 @@ "modern" ], "globalMetadata": { - "_appName": "OpenGSQ", - "_appTitle": "OpenGSQ", + "_appName": "OpenGSQ .NET", + "_appTitle": "OpenGSQ .NET", "_enableSearch": true, "_appLogoPath": "images/logo.png", "_appFaviconPath": "images/favicon.ico", diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.md deleted file mode 100644 index 8b3a794..0000000 --- a/docs/docs/getting-started.md +++ /dev/null @@ -1 +0,0 @@ -# Getting Started \ No newline at end of file diff --git a/docs/docs/installation.md b/docs/docs/installation.md new file mode 100644 index 0000000..60fbb47 --- /dev/null +++ b/docs/docs/installation.md @@ -0,0 +1,7 @@ +# Installation + +You can easily install the OpenGSQ package via the NuGet Package Manager or by running the following command in your terminal: + +```sh +dotnet add package OpenGSQ +``` diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md deleted file mode 100644 index f6ecaa6..0000000 --- a/docs/docs/introduction.md +++ /dev/null @@ -1 +0,0 @@ -# Introduction \ No newline at end of file diff --git a/docs/docs/toc.yml b/docs/docs/toc.yml index d7e9ea8..68d7a5e 100644 --- a/docs/docs/toc.yml +++ b/docs/docs/toc.yml @@ -1,4 +1,6 @@ -- name: Introduction - href: introduction.md -- name: Getting Started - href: getting-started.md \ No newline at end of file +- name: Overview + href: ../index.md + +- name: Get Started +- href: installation.md +- href: usage.md diff --git a/docs/docs/usage.md b/docs/docs/usage.md new file mode 100644 index 0000000..9c7bfac --- /dev/null +++ b/docs/docs/usage.md @@ -0,0 +1,23 @@ +# Usage + +Source Query Protocol + +```cs +using System; +using System.Threading.Tasks; +using OpenGSQ.Protocols; + +class Program +{ + static async Task Main() + { + // Create a new Source object + var source = new Source("45.62.160.71", 27015); + + // Call the GetInfo method + var info = await source.GetInfo(); + + // Now you can use the 'info' object + } +} +``` diff --git a/docs/index.md b/docs/index.md index f9859f8..30a7202 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,11 +1,19 @@ ---- -_layout: landing ---- +# Overview -# This is the **HOMEPAGE**. +OpenGSQ is an open-source game server query libraries that helps developers or admins query game servers easily and efficiently. +While non-specialists are enabled to use this library for query game servers faster through the library. -Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. +## OpenGSQ .NET Library -## Quick Start Notes: +[![Dotnet Package](https://github.com/opengsq/opengsq-dotnet/actions/workflows/dotnet-package.yml/badge.svg)](https://github.com/opengsq/opengsq-dotnet/actions/workflows/dotnet-package.yml) +[![GitHub license](https://img.shields.io/github/license/opengsq/opengsq-dotnet)](https://github.com/opengsq/opengsq-dotnet/blob/main/LICENSE) +[![NuGet Version](http://img.shields.io/nuget/v/OpenGSQ.svg?style=flat)](https://www.nuget.org/packages/OpenGSQ/) +![NuGet Downloads](https://img.shields.io/nuget/dt/OpenGSQ) -1. Add images to the *images* folder if the file is referencing an image. \ No newline at end of file +The OpenGSQ .NET library provides a convenient way to query servers from applications written in the C# language. + +## Community + +Join our Discord and connect with other members to share and learn together. Send a pull request to any of our open source repositories on Github. + +[![OpenGSQ Discord server Banner](https://discord.com/api/guilds/1088231927179395133/widget.png?style=banner2)](https://discord.gg/9BTG3KE9gC)