Update docs

CHANGELOG.md

@@ -0,0 +1,23 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog][Keep a Changelog] and this project adheres to [Semantic Versioning][Semantic Versioning].
+
+## [Unreleased]
+
+## [Released]
+
+## [1.0.0] - 2021-02-XX
+
+### Added
+
+- Everything. This is the first release.
+
+<!-- Links -->
+[Keep a Changelog]: https://keepachangelog.com/
+[Semantic Versioning]: https://semver.org/
+
+[Unreleased]: https://github.com/erri120/GameFinder/compare/v1.0.0...HEAD
+[Released]: https://github.com/erri120/GameFinder/releases
+[1.0.0]: https://github.com/erri120/GameFinder/releases/v1.0.0

CONTRIBUTING.md

@@ -0,0 +1,14 @@
+# Contributing
+
+## Requirements
+
+- [.NET SDK](https://dotnet.microsoft.com/download)
+- IDE: [Visual Studio](https://visualstudio.microsoft.com/) or [Rider](https://www.jetbrains.com/rider/)
+
+## Running Unit Tests
+
+Unit Tests for each Store Handler derive of [`AStoreHandlerTest.cs`](GameFinder.Tests/AStoreHandlerTest.cs) which has the actual test function. Derivatives of `AStoreHandlerTest` can override the Setup and Cleanup function as well as add custom checks before or after finding the games.
+
+The setup functions are intended for use in a CI environment where the `CI` variable is set to `true`. During development I don't recommend setting this variable because some setup functions will modify your registry which you might not want.
+
+I recommend only running the Unit Tests for the specific Store Handler you are currently working on so you don't have to deal with the other setup functions as well.

GameFinder.Example/GameFinder.Example.csproj

@@ -0,0 +1,13 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net5.0-windows</TargetFramework>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\GameFinder\GameFinder.csproj" />
+    </ItemGroup>
+
+</Project>

GameFinder.Example/Program.cs

@@ -0,0 +1,18 @@
+using System;
+using GameFinder.StoreHandlers.Steam;
+
+namespace GameFinder.Example
+{
+    public static class Program
+    {
+        public static void Main(string[] args)
+        {
+            var steamHandler = new SteamHandler();
+            steamHandler.FindAllGames();
+            foreach (var steamGame in steamHandler.Games)
+            {
+                Console.WriteLine($"{steamGame} is located at {steamGame.Path}");
+            }
+        }
+    }
+}

GameFinder.sln

@@ -7,6 +7,10 @@ ProjectSection(SolutionItems) = preProject
 	.editorconfig = .editorconfig
 	.gitattributes = .gitattributes
 	.gitignore = .gitignore
+	CHANGELOG.md = CHANGELOG.md
+	LICENSE = LICENSE
+	README.md = README.md
+	CONTRIBUTING.md = CONTRIBUTING.md
 EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GameFinder.Tests", "GameFinder.Tests\GameFinder.Tests.csproj", "{71531212-A31A-4C35-AFC1-15BDDDC0F668}"

GameFinder/StoreHandlers/Steam/SteamHandler.cs

@@ -28,7 +28,7 @@ public class SteamHandler : AStoreHandler<SteamGame>
         private string SteamConfig { get; set; }
 
         /// <summary>
-        /// List of all found Steam Games
+        /// List of all found Steam Universes
         /// </summary>
         public List<string> SteamUniverses { get; internal set; } = new();
 

GameFinder/StoreType.cs

@@ -21,7 +21,7 @@ public enum StoreType
         /// <summary>
         /// Bethesda Launcher
         /// </summary>
-        [Description("Bethesda Launcher")]
+        [Description("Bethesda.net Launcher")]
         BethNet,
 
         /// <summary>