Skip to content

Commit a0fa9cd

Browse files
author
MPCoreDeveloper
committed
docs: Update README files to v1.1.1 - Localization fix + API deprecations
- Updated NuGet badge to v1.1.1 in root README.md - Added v1.1.1 release notes section with localization bugfix details - Documented culture-independent parsing fixes (CultureInfo.InvariantCulture) - Added obsolete method migration guidance (sync -> async APIs) - Updated CHANGELOG.md with complete v1.1.1 release notes - Updated nuget/README.md with v1.1.1 installation instructions - Added version history and multi-platform support details - No breaking changes - full backward compatibility maintained
1 parent 83d79c9 commit a0fa9cd

File tree

3 files changed

+187
-37
lines changed

3 files changed

+187
-37
lines changed

README.md

Lines changed: 37 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
99
[![.NET](https://img.shields.io/badge/.NET-10.0-blue.svg)](https://dotnet.microsoft.com/download)
10-
[![NuGet](https://img.shields.io/badge/NuGet-1.1.0-blue.svg)](https://www.nuget.org/packages/SharpCoreDB)
10+
[![NuGet](https://img.shields.io/badge/NuGet-1.1.1-blue.svg)](https://www.nuget.org/packages/SharpCoreDB)
1111
[![Build](https://img.shields.io/badge/Build-✅_Passing-brightgreen.svg)](https://github.com/MPCoreDeveloper/SharpCoreDB)
1212
[![Tests](https://img.shields.io/badge/Tests-772_Passing-brightgreen.svg)](https://github.com/MPCoreDeveloper/SharpCoreDB)
1313
[![Sponsor](https://img.shields.io/badge/Sponsor-❤️-ea4aaa?logo=githubsponsors&logoColor=white)](https://github.com/sponsors/mpcoredeveloper)
@@ -17,6 +17,27 @@
1717

1818
## 📌 **Current Status (February 2026)**
1919

20+
### **Version 1.1.1 Released** - Localization Fix + API Cleanup
21+
22+
**Latest Release**: v1.1.1 (February 2026)
23+
24+
#### 🐛 Bug Fixes
25+
- **Critical**: Fixed localization bug affecting date/time formatting in non-English cultures
26+
- **Compatibility**: Resolved culture-dependent parsing issues (decimal separators, date formats)
27+
- **Portability**: Database files now fully portable across different regional settings
28+
29+
#### 🔄 API Improvements
30+
- **Deprecated Methods**: Added `[Obsolete]` attributes to legacy sync methods
31+
- **Migration Path**: Clear upgrade guidance to async patterns (see Quickstart below)
32+
- **Breaking Changes**: None - full backward compatibility maintained
33+
34+
#### 📦 Quick Install
35+
```bash
36+
dotnet add package SharpCoreDB --version 1.1.1
37+
```
38+
39+
---
40+
2041
### **All Phases Complete — Phases 1-8 + DDL Extensions**
2142

2243
| Area | Status |
@@ -52,13 +73,17 @@ A high-performance, encrypted, embedded database engine for .NET 10 with **B-tre
5273

5374
## 🚀 Quickstart
5475

55-
Install:
76+
Install the latest version:
5677

5778
```bash
79+
# Install SharpCoreDB v1.1.1
80+
dotnet add package SharpCoreDB --version 1.1.1
81+
82+
# Or use wildcard for latest
5883
dotnet add package SharpCoreDB
5984
```
6085

61-
Use:
86+
Use (Async API - Recommended):
6287

6388
```csharp
6489
using Microsoft.Extensions.DependencyInjection;
@@ -72,20 +97,22 @@ var factory = provider.GetRequiredService<DatabaseFactory>();
7297
using var db = factory.Create("./app_db", "StrongPassword!");
7398

7499
// Create table with B-tree index
75-
db.ExecuteSQL("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, age INTEGER)");
76-
db.ExecuteSQL("CREATE INDEX idx_age ON users(age) USING BTREE");
100+
await db.ExecuteSQLAsync("CREATE TABLE users (id INTEGER PRIMARY KEY, name TEXT, age INTEGER)");
101+
await db.ExecuteSQLAsync("CREATE INDEX idx_age ON users(age) USING BTREE");
77102

78-
// Fast inserts
79-
db.ExecuteSQL("INSERT INTO users VALUES (1, 'Alice', 30)");
103+
// Fast inserts with async API (recommended)
104+
await db.ExecuteSQLAsync("INSERT INTO users VALUES (1, 'Alice', 30)");
80105

81-
// Fast queries with batch API
82-
var rows = db.ExecuteQuery("SELECT * FROM users WHERE age > 25");
106+
// Fast queries with async batch API
107+
var rows = await db.ExecuteQueryAsync("SELECT * FROM users WHERE age > 25");
83108

84109
// Support for large data (>256KB)
85110
var largeData = new byte[10_000_000]; // 10MB
86-
db.ExecuteSQL("INSERT INTO files VALUES (1, @data)");
111+
await db.ExecuteSQLAsync("INSERT INTO files VALUES (1, @data)");
87112
```
88113

114+
> ⚠️ **API Migration Notice (v1.1.1)**: Legacy synchronous methods (`ExecuteSQL`, `ExecuteQuery`, `Flush`, `ForceSave`) are marked as `[Obsolete]`. Please migrate to async methods (`ExecuteSQLAsync`, `ExecuteQueryAsync`, `FlushAsync`, `ForceSaveAsync`) for better performance, cancellation support, and culture-independent behavior.
115+
89116
---
90117

91118
## ⭐ Key Features

docs/CHANGELOG.md

Lines changed: 38 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,45 @@ All notable changes to SharpCoreDB will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
66
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
77

8-
## [Unreleased]
8+
## [1.1.1] - 2026-02-08
9+
10+
### 🐛 Fixed
11+
- **Critical**: Fixed localization bug affecting date/time formatting in non-English locales
12+
- Decimal parsing now uses `CultureInfo.InvariantCulture` throughout engine
13+
- DateTime serialization now culture-independent using ISO 8601 format
14+
- Resolved issues with comma vs. period decimal separators (European vs. US locales)
15+
- Fixed floating-point value corruption in non-US regional settings
16+
- **Compatibility**: Database files now fully portable across different regional settings
17+
- **Impact**: Prevents data corruption when database is accessed from systems with different locale settings
18+
19+
### 🔄 Changed
20+
- **API Deprecation**: Added `[Obsolete]` attributes to legacy synchronous methods with migration guidance
21+
- `Database.ExecuteSQL()` → Use `Database.ExecuteSQLAsync()` instead
22+
- `Database.ExecuteQuery()` → Use `Database.ExecuteQueryAsync()` instead
23+
- `Database.Flush()` → Use `Database.FlushAsync()` instead
24+
- `Database.ForceSave()` → Use `Database.ForceSaveAsync()` instead
25+
- `SingleFileStorageProvider.Flush()` → Use `SingleFileStorageProvider.FlushAsync()` instead
26+
- All obsolete methods include clear migration instructions in compiler warnings
27+
- **Documentation**: Updated README.md and examples to use async patterns as best practice
28+
- **Performance Note**: Async methods provide better performance, cancellation support, and guaranteed culture-independence
29+
30+
### ✅ No Breaking Changes
31+
- All deprecated methods remain fully functional in v1.1.1
32+
- 100% backward compatibility maintained with existing codebases
33+
- Existing synchronous code continues to work without modifications
34+
- Deprecation warnings are informational only - upgrade at your convenience
35+
36+
### 📊 Version Info
37+
- **Package Version**: 1.1.1
38+
- **Release Date**: February 8, 2026
39+
- **NuGet**: https://www.nuget.org/packages/SharpCoreDB/1.1.1
40+
- **GitHub Release**: https://github.com/MPCoreDeveloper/SharpCoreDB/releases/tag/v1.1.1
41+
42+
---
43+
44+
## [1.1.0] - 2026-01-31
945

10-
### 🎉 **MAJOR ACHIEVEMENT** - Single File Mode Beats SQLite AND LiteDB! (31 januari 2026)
46+
### 🎉 **MAJOR ACHIEVEMENT** - Single File Mode Beats SQLite AND LiteDB!
1147

1248
**SharpCoreDB Single File mode is now the fastest embedded database for INSERT operations!** 🏆
1349

nuget/README.md

Lines changed: 112 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,141 @@
1-
# NuGet Packaging
1+
# NuGet Packaging - SharpCoreDB
22

33
This directory contains assets for NuGet packaging.
44

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+
557
## Package Icon
658

759
Place your package icon here as `icon.png` (128x128 or 256x256 pixels recommended).
860

9-
Current icon location: `../SharpCoreDB.jpg` (referenced in Directory.Build.props)
61+
Current icon location: `../SharpCoreDB.jpg` (referenced in SharpCoreDB.csproj)
1062

1163
## README
1264

1365
A package README can be included by referencing `README.md` from the root.
1466

1567
## Building Packages
1668

17-
To build NuGet packages:
69+
To build NuGet packages for v1.1.1:
1870

1971
```bash
20-
# Build all packages
72+
# Build all packages (v1.1.1)
2173
dotnet pack --configuration Release --output ./artifacts
2274

2375
# Build specific package
2476
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
2580
```
2681

2782
## Publishing to NuGet
2883

2984
```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
3290
```
3391

3492
## Package Configuration
3593

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

Comments
 (0)