Update docs

opengsq · Jan 21, 2024 · 36d956e · 36d956e
1 parent c58905e
commit 36d956e
Show file tree

Hide file tree

Showing 7 changed files with 53 additions and 15 deletions.
diff --git 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
diff --git a/docs/docs/installation.md 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
diff --git 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
+- 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
@@ -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
@@ -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.
+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)