|
1 | | -# NuGet Packaging |
| 1 | +# NuGet Packaging - SharpCoreDB |
2 | 2 |
|
3 | 3 | This directory contains assets for NuGet packaging. |
4 | 4 |
|
| 5 | +## 📦 Current Version: **1.1.1** (February 2026) |
| 6 | + |
| 7 | +### Installation |
| 8 | + |
| 9 | +```bash |
| 10 | +# Install latest version (1.1.1) |
| 11 | +dotnet add package SharpCoreDB --version 1.1.1 |
| 12 | + |
| 13 | +# Or install with wildcard (gets latest) |
| 14 | +dotnet add package SharpCoreDB |
| 15 | +``` |
| 16 | + |
| 17 | +### Package Details |
| 18 | +- **Package ID**: SharpCoreDB |
| 19 | +- **Current Version**: 1.1.1 |
| 20 | +- **License**: MIT |
| 21 | +- **Target Framework**: .NET 10.0 |
| 22 | +- **Language**: C# 14 |
| 23 | +- **NuGet Gallery**: https://www.nuget.org/packages/SharpCoreDB/1.1.1 |
| 24 | + |
| 25 | +### Version History |
| 26 | + |
| 27 | +- **v1.1.1** (Feb 8, 2026): |
| 28 | + - 🐛 Fixed critical localization bug (culture-independent parsing) |
| 29 | + - 🔄 Added `[Obsolete]` attributes to sync methods |
| 30 | + - ✅ No breaking changes - full backward compatibility |
| 31 | +- **v1.1.0** (Jan 31, 2026): |
| 32 | + - 🎉 Major RDBMS improvements |
| 33 | + - 🏆 Single-File performance breakthrough (37% faster than SQLite) |
| 34 | + - ⚡ 17x INSERT speedup with in-memory cache architecture |
| 35 | +- **v1.0.0**: Initial production release |
| 36 | + |
| 37 | +### Quick Start |
| 38 | + |
| 39 | +```csharp |
| 40 | +using Microsoft.Extensions.DependencyInjection; |
| 41 | +using SharpCoreDB; |
| 42 | + |
| 43 | +var services = new ServiceCollection(); |
| 44 | +services.AddSharpCoreDB(); |
| 45 | +var provider = services.BuildServiceProvider(); |
| 46 | +var factory = provider.GetRequiredService<DatabaseFactory>(); |
| 47 | + |
| 48 | +// Async API (recommended as of v1.1.1) |
| 49 | +using var db = factory.Create("./app_db", "StrongPassword!"); |
| 50 | +await db.ExecuteSQLAsync("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT)"); |
| 51 | +await db.ExecuteSQLAsync("INSERT INTO users VALUES (1, 'Alice')"); |
| 52 | +var rows = await db.ExecuteQueryAsync("SELECT * FROM users"); |
| 53 | +``` |
| 54 | + |
| 55 | +--- |
| 56 | + |
5 | 57 | ## Package Icon |
6 | 58 |
|
7 | 59 | Place your package icon here as `icon.png` (128x128 or 256x256 pixels recommended). |
8 | 60 |
|
9 | | -Current icon location: `../SharpCoreDB.jpg` (referenced in Directory.Build.props) |
| 61 | +Current icon location: `../SharpCoreDB.jpg` (referenced in SharpCoreDB.csproj) |
10 | 62 |
|
11 | 63 | ## README |
12 | 64 |
|
13 | 65 | A package README can be included by referencing `README.md` from the root. |
14 | 66 |
|
15 | 67 | ## Building Packages |
16 | 68 |
|
17 | | -To build NuGet packages: |
| 69 | +To build NuGet packages for v1.1.1: |
18 | 70 |
|
19 | 71 | ```bash |
20 | | -# Build all packages |
| 72 | +# Build all packages (v1.1.1) |
21 | 73 | dotnet pack --configuration Release --output ./artifacts |
22 | 74 |
|
23 | 75 | # Build specific package |
24 | 76 | dotnet pack src/SharpCoreDB/SharpCoreDB.csproj --configuration Release --output ./artifacts |
| 77 | + |
| 78 | +# Build with explicit version |
| 79 | +dotnet pack -p:Version=1.1.1 --configuration Release --output ./artifacts |
25 | 80 | ``` |
26 | 81 |
|
27 | 82 | ## Publishing to NuGet |
28 | 83 |
|
29 | 84 | ```bash |
30 | | -# Publish (requires API key) |
31 | | -dotnet nuget push artifacts/*.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json |
| 85 | +# Publish v1.1.1 (requires API key) |
| 86 | +dotnet nuget push artifacts/SharpCoreDB.1.1.1.nupkg --api-key YOUR_API_KEY --source https://api.nuget.org/v3/index.json |
| 87 | + |
| 88 | +# Verify publication |
| 89 | +# Visit: https://www.nuget.org/packages/SharpCoreDB/1.1.1 |
32 | 90 | ``` |
33 | 91 |
|
34 | 92 | ## Package Configuration |
35 | 93 |
|
36 | | -Package metadata is configured in `Directory.Build.props` at the root: |
37 | | -- Package ID |
38 | | -- Version |
39 | | -- Authors |
40 | | -- Description |
41 | | -- License |
42 | | -- Icon |
43 | | -- Tags |
44 | | -- Repository URL |
45 | | - |
46 | | -## Packages |
47 | | - |
48 | | -The following packages are produced: |
49 | | - |
50 | | -1. **SharpCoreDB** - Core library |
51 | | -2. **SharpCoreDB.Extensions** - Extension methods |
52 | | -3. **SharpCoreDB.Data.Provider** - ADO.NET provider |
53 | | -4. **SharpCoreDB.EntityFrameworkCore** - EF Core provider |
54 | | -5. **SharpCoreDB.Serilog.Sinks** - Serilog sink |
| 94 | +Package metadata is configured in `src/SharpCoreDB/SharpCoreDB.csproj`: |
| 95 | +- **Package ID**: SharpCoreDB |
| 96 | +- **Version**: 1.1.1 |
| 97 | +- **Authors**: MPCoreDeveloper |
| 98 | +- **Company**: SharpCoreDB |
| 99 | +- **Description**: Lightweight, encrypted, file-based database engine with SQL support, AES-256-GCM encryption, and production-ready performance |
| 100 | +- **License**: MIT |
| 101 | +- **Icon**: SharpCoreDB.jpg |
| 102 | +- **Tags**: database, embedded, encryption, sql, nosql, net10, csharp14, performance |
| 103 | +- **Repository**: https://github.com/MPCoreDeveloper/SharpCoreDB |
| 104 | + |
| 105 | +## Multi-Platform Support |
| 106 | + |
| 107 | +The package includes runtime-specific assemblies for: |
| 108 | +- Windows x64 (win-x64) |
| 109 | +- Windows ARM64 (win-arm64) |
| 110 | +- Linux x64 (linux-x64) |
| 111 | +- Linux ARM64 (linux-arm64) |
| 112 | +- macOS x64 (osx-x64) |
| 113 | +- macOS ARM64 (osx-arm64) |
| 114 | + |
| 115 | +## Packages Produced |
| 116 | + |
| 117 | +1. **SharpCoreDB** (v1.1.1) - Core library |
| 118 | + - Main NuGet package |
| 119 | + - All storage engines included |
| 120 | + - Multi-platform support |
| 121 | + - Symbol package (.snupkg) for debugging |
| 122 | + |
| 123 | +2. **Future Packages** (Planned) |
| 124 | + - SharpCoreDB.Extensions - Extension methods |
| 125 | + - SharpCoreDB.Data.Provider - ADO.NET provider |
| 126 | + - SharpCoreDB.EntityFrameworkCore - EF Core provider |
| 127 | + - SharpCoreDB.Serilog.Sinks - Serilog sink |
| 128 | + |
| 129 | +## Release Checklist |
| 130 | + |
| 131 | +Before publishing v1.1.1: |
| 132 | + |
| 133 | +- [x] Version updated in SharpCoreDB.csproj (1.1.1) |
| 134 | +- [x] CHANGELOG.md updated with release notes |
| 135 | +- [x] README.md updated with version badge |
| 136 | +- [x] All tests passing (772/772) |
| 137 | +- [x] Build succeeds with 0 errors |
| 138 | +- [x] Package builds successfully |
| 139 | +- [ ] Package published to NuGet.org |
| 140 | +- [ ] GitHub release created with tag v1.1.1 |
| 141 | +- [ ] Release notes published on GitHub |
0 commit comments