Merge pull request #52 from PTCInc/chore-doc-cleanup

chore(doc): Update readmes

Author: rlabbeptc

.github/workflows/nuget-test-and-build.yml

@@ -17,7 +17,7 @@ on:
     #   - 'Kepware.Api.Sample/**'
     #   - 'KepwareSync.Service/**'
     #   - '.github/workflows/nuget-test-and-build.yml'  
-      - '!*.md' # Exclude markdown files
+      - '!**/*.md' # Exclude markdown files
 
 jobs:
   draft-release:

Kepware.Api.Sample/README.md

@@ -11,7 +11,7 @@ The `Kepware.Api.Sample` project demonstrates how to use the `Kepware.Api` libra
 
 ## Prerequisites
 - A running Kepware server with the Configuration API enabled.
-- .NET SDK x.0 or later.
+- .NET SDK 8.0 or later.
 - Basic understanding of C# programming.
 
 ## Usage
@@ -28,7 +28,7 @@ The `Kepware.Api.Sample` project demonstrates how to use the `Kepware.Api` libra
                name: "sample",
                baseUrl: "https://localhost:57512",
                apiUserName: "Administrator",
-               apiPassword: "InrayTkeDocker2024!",
+               apiPassword: "StrongAdminPassword2025!",
                disableCertificateValidation: true
            );
        })
@@ -60,7 +60,7 @@ static async Task Main(string[] args)
                 name: "sample",
                 baseUrl: "https://localhost:57512",
                 apiUserName: "Administrator",
-                apiPassword: "InrayTkeDocker2024!",
+                apiPassword: "StrongAdminPassword2025!",
                 disableCertificateValidation: true
             );
         })
@@ -92,6 +92,6 @@ static async Task Main(string[] args)
 This sample project is provided "as is" under the MIT License. See the [LICENSE](../LICENSE.txt) file for details.
 
 ## Support
-For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository. 
+For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository.
 
 See [Repository Guidelines](../docs/repo-guidelines.md) for more information.

Kepware.Api/README.md

@@ -6,30 +6,30 @@
 ## Overview
 The `Kepware.Api` library provides a robust client implementation to interact with the Kepware Configuration API. It supports managing channels, devices, tags, and other configurations programmatically while ensuring secure and efficient communication.
 
-This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP). For reference, Kepware Server in this documentation will refer to both TKS and KEP versions.
+This package is designed to work with all versions of Kepware that support the Configuration API including Kepware Server (KS), and Kepware Edge (KE). For reference, Kepware Server in this documentation will also imply Thingworx Kepware Server and KEPServerEX versions prior to v7.0 when v6.x is referenced.
 
 ## Features
 1. Connect to Kepware Configuration APIs securely with HTTPS and optional certificate validation.
 2. Perform CRUD operations for the following Kepware configuration objects:
 
-| Features      | TKS/KEP       | TKE           |
+| Features      | KS       | KE           |
 | :----------:  | :----------:  | :----------:  |
 | **Project Properties** <br /> *(Get Only)* | Y | Y |
 | **Connectivity** <br /> *(Channel, Devices, Tags, Tag Groups)* | Y | Y |
 | **Administration** <br /> *(User Groups, Users, UA Endpoints, Local License Server)* | Y[^1] | Y |
-| **Product Info and Health Status[^4]** | Y | Y |
-| **Export Project[^2]**| Y | Y |
+| **Product Info and Health Status** | Y[^4] | Y |
+| **Export Project**| Y[^2] | Y |
 | **Import Project (via CompareAndApply)[^3]**| Y | Y |
-| **Import Project (via JsonProjectLoad Service)[^2]**| N | N |
+| **Import Project (via JsonProjectLoad Service)**| N[^2] | N |
 
 [^1]: UA Endpoints and Local License Server supported for Kepware Edge only
-[^2]: JsonProjectLoad was added to Kepware Server v6.17 / Kepware Edge v1.10 and later builds, the SDK detects the server version and uses the appropriate service or loads the project by multiple requests if using KepwareApiClient.LoadProject.
+[^2]: JsonProjectLoad was added to Kepware Server v6.17 and later builds, the SDK detects the server version and uses the appropriate service or loads the project by multiple requests if using KepwareApiClient.LoadProject.
 [^3]: CompareAndApply is handled by the SDK, it compares the source project with the server project and applies the changes. The JsonProjectLoad service is a direct call to the server to load a project.
-[^4]: Added to Kepware Server v6.13 / Kepware Edge v1.5 and later builds
+[^4]: Added to Kepware Server v6.13 and later builds
 
 3. Configuration API *Services* implemented:
 
-| Services      | TKS/KEP       | TKE           |
+| Services      | KS       | KE           |
 | :----------:  | :----------:  | :----------:  |
 | **TagGeneration** <br /> *(for supported drivers)* | Y | Y |
 | **ReinitializeRuntime** | Y* | Y |
@@ -42,25 +42,7 @@ This package is designed to work with all versions of Kepware that support the C
 
 ## Installation
 
-To install the package via the GitHub NuGet feed, you need to configure your project to use the GitHub Packages repository.
-
-### Add the GitHub NuGet source
-
-Add the following configuration to your `NuGet.config` file in the root of your project or in the global configuration directory:
-
-```xml
-<configuration>
-  <packageSources>
-    <add key="GitHub" value="https://nuget.pkg.github.com/YourUsername/index.json" />
-  </packageSources>
-  <packageSourceCredentials>
-    <GitHub>
-      <add key="Username" value="YourUsername" />
-      <add key="ClearTextPassword" value="YOUR_PERSONAL_ACCESS_TOKEN" />
-    </GitHub>
-  </packageSourceCredentials>
-</configuration>
-```
+Kepware.Api NuGet package is available from NuGet repository.
 
 1. Add the `Kepware.Api` library to your project as a reference.
    ```bash
@@ -73,7 +55,7 @@ Add the following configuration to your `NuGet.config` file in the root of your
        name: "default",
        baseUrl: "https://localhost:57512",
        apiUserName: "Administrator",
-       apiPassword: "password",
+       apiPassword: "StrongAdminPassword2025!",
        disableCertificateValidation: true
    );
    ```

KepwareSync.Service/README.md

@@ -202,7 +202,7 @@ docker run -d \
   -e KEPWARE__PRIMARY__USERNAME=Administrator \
   -e KEPWARE__PRIMARY__PASSWORD=StrongAdminPassword2025! \
   -e KEPWARE__PRIMARY__HOST=https://localhost:57512 \
-  ghcr.io/bobiene/kepware-sync-service:latest
+  kepware-sync-service:latest
 ```
 
 This command:
@@ -223,28 +223,26 @@ version: '3.8'
 
 services:
   kepware:
-    image: inrayhub.azurecr.io/kepware_edge:1.9-beta
+    image: kepedge:<version>
     pull_policy: always
     networks:
-      - tke_network
+      - ke_network
     ports:
       - "57513:57513"
       - "49330:49330"
     environment:
       - EDGEADMINPW=StrongAdminPassword2025!
-      - LICENSE_SERVER_ADDRESS=192.168.189.81
-      - TZ=UTC
     volumes:
       - ./data/config:/opt/tkedge/v1/.config
     restart: unless-stopped
 
   kepware-sync:
-    image: ghcr.io/bobiene/kepware-sync-service:latest
+    image: kepware-sync-service:latest
     pull_policy: always
     depends_on:
       - kepware
     networks:
-      - tke_network
+      - ke_network
     volumes:
       - config_volume:/app/config
     environment:
@@ -260,7 +258,7 @@ services:
     depends_on:
       - kepware-sync
     networks:
-      - tke_network
+      - ke_network
     environment:
       - GIT_SYNC_REPO=https://your-repo.git
       - GIT_SYNC_BRANCH=main
@@ -273,7 +271,7 @@ volumes:
   config_volume:
 
 networks:
-  tke_network:
+  ke_network:
     driver: bridge
 ```
 
@@ -286,6 +284,6 @@ networks:
 This tool is provided "as is" under the MIT License. See the [LICENSE](../LICENSE.txt) file for details.
 
 ## Support
-For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository. 
+For any issues, please open an Issue within the repository. For questions or feature requests, please open a Discussion thread within the repository.
 
 See [Repository Guidelines](../docs/repo-guidelines.md) for more information.

README.md

@@ -1,14 +1,15 @@
 # Kepware Configuration API SDK for .NET (Currently in Beta)
 
-[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/dotnet.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
+[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/nuget-test-and-build.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
 [![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/docker-build-and-push.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
+[![Build Status](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions/workflows/syncservice-build.yml/badge.svg)](https://github.com/PTCInc/Kepware-ConfigAPI-SDK-dotnet/actions)
 [![NuGet](https://img.shields.io/nuget/v/Kepware.Api.svg)](https://www.nuget.org/packages/Kepware.Api/)
 
 
 ## Overview
 The Kepware Configuration API SDK for .NET provides tools and libraries to interact with the Kepware Configuration REST API, enabling configuration management for Kepware servers. This repository includes examples and utilities to streamline development for deployment tools, including a service for continuous synchronization and an API client library. 
 
-This package is designed to work with all versions of Kepware that support the Configuration API including Thingworx Kepware Server (TKS), Thingworx Kepware Edge (TKE) and KEPServerEX (KEP). For reference, Kepware Server in this documentation will refer to both TKS and KEP versions.
+This package is designed to work with all versions of Kepware that support the Configuration API including Kepware Server (KS), Kepware Edge (KE), Thingworx Kepware Server (TKS), and KEPServerEX (KEP). For reference, Kepware Server in this documentation will also imply Thingworx Kepware Server and KEPServerEX versions prior to v7.0 when v6.x is referenced.
 
 ## Features
 - [**API Client Library**](./Kepware.Api/README.md): Simplify interaction with the Kepware Configuration API.
@@ -26,7 +27,7 @@ A .NET library providing an easy-to-use client for interacting with the Kepware
 
 [Readme for Kepware.Api](./Kepware.Api/README.md)
 
-**API reference documentation is available on [TBD]()**
+**API reference documentation is available on [Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-dotnet/api/Kepware.Api.html)**
 
 ### 2. `KepwareSync.Service`
 A service application for synchronizing configurations between Kepware servers and the local filesystem. It supports monitoring and synchronization in real time.
@@ -89,10 +90,6 @@ See [Repository Guidelines](./docs/repo-guidelines.md) for more information.
 
 **Visit:**
 
-- [Kepware.Api API Documentation on Github Pages]()
+- [Kepware.Api API Documentation on Github Pages](https://ptcinc.github.io/Kepware-ConfigAPI-SDK-dotnet/)
 - [Kepware.com](https://www.kepware.com/)
 - [PTC.com](https://www.ptc.com/)
-
----
-Ready to dive in? Check out the project-specific Readmes for detailed information on how to get started!
-