Skip to content

Commit 113308f

Browse files
committed
docs: update README for multi-target support and improve package descriptions
1 parent ae50cff commit 113308f

1 file changed

Lines changed: 19 additions & 17 deletions

File tree

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# BAUER GROUP Shared Platform
22

33
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
4-
[![.NET](https://img.shields.io/badge/.NET-10.0-512BD4)](https://dotnet.microsoft.com/)
4+
[![.NET 10](https://img.shields.io/badge/.NET-10.0-512BD4)](https://dotnet.microsoft.com/)
5+
[![.NET 8](https://img.shields.io/badge/.NET-8.0-512BD4)](https://dotnet.microsoft.com/)
6+
[![.NET Standard 2.0](https://img.shields.io/badge/.NET%20Standard-2.0-512BD4)](https://dotnet.microsoft.com/)
57
[![NuGet](https://img.shields.io/badge/NuGet-Ready-004880)](https://www.nuget.org/)
68

7-
A comprehensive .NET 10 shared library platform providing essential building blocks for enterprise applications within the BAUER GROUP ecosystem.
9+
A comprehensive multi-target .NET shared library platform providing essential building blocks for enterprise applications within the BAUER GROUP ecosystem. Supports .NET 10, .NET 8, and .NET Standard 2.0 for maximum compatibility.
810

911
---
1012

@@ -14,7 +16,7 @@ The BAUER GROUP Shared Platform is a modular, multi-project solution designed to
1416

1517
### Key Features
1618

17-
- **Modern .NET 10**: Built on the latest .NET platform with full support for modern C# features
19+
- **Multi-Target Support**: .NET 10, .NET 8, and .NET Standard 2.0 for broad compatibility
1820
- **Modular Architecture**: Pick only the packages you need
1921
- **Enterprise-Ready Logging**: NLog-based logging with Sentry integration for error tracking
2022
- **Data Layer**: Support for SQLite (encrypted), LiteDB, and in-memory databases
@@ -27,16 +29,16 @@ The BAUER GROUP Shared Platform is a modular, multi-project solution designed to
2729

2830
## Packages
2931

30-
| Package | Description |
31-
|---------|-------------|
32-
| `BAUERGROUP.Shared.Core` | Core utilities, extensions, logging (NLog + Sentry), error tracking |
33-
| `BAUERGROUP.Shared.Data` | Data persistence: SQLite, LiteDB, in-memory database, caching |
34-
| `BAUERGROUP.Shared.API` | E-commerce integrations: Shopify, Shopware 5/6, WooCommerce |
35-
| `BAUERGROUP.Shared.API.Shipping` | Shipping providers: DHL, DPD, GLS, Deutsche Post, UPS |
36-
| `BAUERGROUP.Shared.Cloud` | Cloud services: Cloudinary media management |
37-
| `BAUERGROUP.Shared.Desktop` | WPF/WinForms utilities, behaviors, converters |
38-
| `BAUERGROUP.Shared.Desktop.Browser` | Embedded Chromium browser (CefSharp) for WPF |
39-
| `BAUERGROUP.Shared.Desktop.Reporting` | Stimulsoft Reports integration* |
32+
| Package | Target Frameworks | Description |
33+
|---------|-------------------|-------------|
34+
| `BAUERGROUP.Shared.Core` | net10.0, net8.0, netstandard2.0 | Core utilities, extensions, logging (NLog + Sentry), error tracking |
35+
| `BAUERGROUP.Shared.Data` | net10.0, net8.0, netstandard2.0 | Data persistence: SQLite, LiteDB, in-memory database, caching |
36+
| `BAUERGROUP.Shared.API` | net10.0, net8.0, netstandard2.0 | E-commerce integrations: Shopify, Shopware 5/6, WooCommerce |
37+
| `BAUERGROUP.Shared.API.Shipping` | net10.0, net8.0, netstandard2.0 | Shipping providers: DHL, DPD, GLS, Deutsche Post, UPS |
38+
| `BAUERGROUP.Shared.Cloud` | net10.0, net8.0 | Cloud services: Cloudinary media management |
39+
| `BAUERGROUP.Shared.Desktop` | net10.0-windows, net8.0-windows | WPF/WinForms utilities, behaviors, converters |
40+
| `BAUERGROUP.Shared.Desktop.Browser` | net10.0-windows, net8.0-windows | Embedded Chromium browser (CefSharp) for WPF |
41+
| `BAUERGROUP.Shared.Desktop.Reporting` | net10.0-windows, net8.0-windows | Stimulsoft Reports integration* |
4042

4143
*\*Requires separate Stimulsoft license*
4244

@@ -138,8 +140,8 @@ WPFToolboxBrowser.ChromeEmbeddedWebbrowserWindow(
138140

139141
### Runtime Requirements
140142

141-
- **.NET 10.0** or later
142-
- **Windows** (for Desktop packages)
143+
- **.NET 10.0**, **.NET 8.0**, or **.NET Standard 2.0** compatible runtime
144+
- **Windows** (for Desktop packages: `Desktop`, `Desktop.Browser`, `Desktop.Reporting`)
143145

144146
### Optional Requirements
145147

@@ -181,8 +183,8 @@ BAUERGROUP.Shared.Plattform/
181183

182184
### Prerequisites
183185

184-
- [.NET 10 SDK](https://dotnet.microsoft.com/download)
185-
- Visual Studio 2022 (17.8+) or JetBrains Rider
186+
- [.NET 10 SDK](https://dotnet.microsoft.com/download) (includes support for .NET 8 and earlier)
187+
- Visual Studio 2022 (17.12+) or JetBrains Rider 2024.3+
186188

187189
### Build
188190

0 commit comments

Comments
 (0)