Merge pull request #178 from CodebreakerApp/177-nuget-packaged-readme-file

177 nuget packaged readme file

Author: christiannagel

src/Codebreaker.ViewModels/Components/SelectedFieldViewModel.cs

@@ -1,9 +1,19 @@
 namespace Codebreaker.ViewModels.Models;
 
+/// <summary>
+/// Represents a field in a move.
+/// </summary>
+/// <param name="possibleColors">The possible colors for this field.</param>
 public partial class Field(string[] possibleColors) : ObservableObject
 {
+    /// <summary>
+    /// The selected color for this field.
+    /// </summary>
     [ObservableProperty]
     private string? _color;
 
+    /// <summary>
+    /// The possible colors for this field.
+    /// </summary>
     public string[] PossibleColors { get; init; } = possibleColors;
 }

src/Codebreaker.ViewModels/Models/Field.cs

@@ -1,5 +1,6 @@
 namespace Codebreaker.ViewModels.Services;
 
+[Obsolete("Use IInfoBarService instead.")]
 public interface IDialogService
 {
     Task ShowMessageAsync(string message);

src/Codebreaker.ViewModels/Services/GameInfoService.cs

@@ -8,32 +8,71 @@ See https://github.com/codebreakerapp for more information on the complete solut
 
 ## The ViewModels
 
-| Class | Description |
-|-------|-------------|
-| GamePageViewModel | The GamePageViewModel is the view-model type for the game page with commands to start games, set moves. |
-| GameViewModel | The GameViewModel is the view-model type for game information. |
-| MoveViewModel | The MoveViewModel is the view-model type for a game move. |
-| InfoMessageViewModel | Alternative option of IDialogService |
+### GamePageViewModel
+The _GamePageViewModel_ is the view-model type for the game page with commands to start games, set moves.  
+The _GamePageViewModel_ is the main view-model type to communicate with the application.
 
-The `GamePageViewModel` is the main view-model type to communicate with the application.
+| Members     | Description        |
+|------------|--------------------|
+| ctor | Needs `IGamesClient` (communication with the games-service API), `IInfoBarService` |
+| Game | The current game |
+| IsLoading | Indicates processing activitiy, where showing a loading indicator is appropriate |
+| SelectedFields | The fields used for selecting the colors for the next move |
+| Username | The username of the player. This name is used when starting the game |
+| StartGameCommand | Command to start a new game |
+| MakeMoveCommand | Command to set a move |
+
+## Model types
+
+The following model types are used to contain information about the game.
+
+### Game
+
+| Members     | Description        |
+|------------|--------------------|
+| Id | The ID of the game |
+| GameType | The type of the game |
+| PlayerName | The name of the player |
+| StartTime | The start time of the game |
+| EndTime | The end time of the game |
+| Duration | The duration of the game |
+| NumberCodes | The number of codes in the game |
+| MaxMoves | The maximum number of moves allowed |
+| IsFinished | Indicates if the game is finished |
+| IsVictory | Indicates if the game is a victory |
+| FieldValues | The values of the fields |
+| Moves | The moves made in the game |
+
+### Move
 
 | Members     | Description        |
 |------------|--------------------|
-| ctor | Needs `IGamesClient` (communication with the games-service API), `IOptions<GamePageViewModelOptions>`, `IDialogService` |
+| GuessPegs | The guess pegs from the user for this move |
+| KeyPegs | The result from the analyer for this move based on the associated game that contains the move. (Null if the move was not analyzed yet.) |
 
-### Supporting types
+### Field
 
-| Class | Description |
-|-------|-------------|
-| GameMode | An enumeration - is the game not running, started, are moves set, lost, won? |
+| Members     | Description        |
+|------------|--------------------|
+| PossibleColors | The possible colors for the field |
+| Color | The selected color for the field |
 
-In the constructor, inject the `HttpClient` class. You can use `Microsoft.Extensions.Http` to configure the `HttpClient` class.
 
-## Model types
+## Services
+### IInfoBarService / InfoBarService
+Service to show messages in the info bar.  
+The UI is able to bind to the `Messages`-ObservableCollection for displaying the mssages.
+
+```C#
+// Register the service in the platform-specific project
+services.AddScoped<IInfoBarService, InfoBarService>();
+```
 
-The following model types are used to return information about the game.
+### INavigationService
+Interface for the service to navigate between pages.  
+The implementation for this interface needs to be made by the platform-specific project.
 
-| Model type | Description |
-|------------|-------------|
-| Game | Contains the game id, the game status, the game moves and the game result |
-| Move | Contains the move number, the guess (`GuessPegs`) and the result of the guess (`KeyPegs`) |
+```C#
+// Register the service in the platform-specific project
+services.AddScoped<INavigationService, MyPlatformSpecificNavigationServiceImplementation>();
+```