Skip to content

Commit f7c1e6a

Browse files
committed
- Add Code Comments and documentation
2 parents 6011984 + d6f03fc commit f7c1e6a

File tree

7 files changed

+377
-17
lines changed

7 files changed

+377
-17
lines changed

GitVersion.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
next-version: 1.0.0
1+
next-version: 1.2.0
22
tag-prefix: '[vV]'
33
mode: ContinuousDeployment
44
branches:

README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# <img src="https://github.com/CodeShayk/TurboMapper/blob/master/Images/ninja-icon-16.png" alt="ninja" style="width:30px;"/> TurboMapper v1.0.0
1+
# <img src="https://github.com/CodeShayk/TurboMapper/blob/master/Images/ninja-icon-16.png" alt="ninja" style="width:30px;"/> TurboMapper v1.2.0
22
[![NuGet version](https://badge.fury.io/nu/TurboMapper.svg)](https://badge.fury.io/nu/TurboMapper) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/CodeShayk/TurboMapper/blob/master/LICENSE.md)
33
[![GitHub Release](https://img.shields.io/github/v/release/CodeShayk/TurboMapper?logo=github&sort=semver)](https://github.com/CodeShayk/TurboMapper/releases/latest)
44
[![master-build](https://github.com/CodeShayk/TurboMapper/actions/workflows/Master-Build.yml/badge.svg)](https://github.com/CodeShayk/TurboMapper/actions/workflows/Master-Build.yml)
@@ -10,24 +10,65 @@
1010
## Introduction
1111
### What is TurboMapper?
1212
`TurboMapper` is a lightweight, high-performance object mapper for .NET that provides both shallow and deep mapping capabilities. It serves as a free alternative to AutoMapper with a simple, intuitive API.
13-
## Getting Started?
13+
14+
## Getting Started
1415
### i. Installation
1516
Install the latest version of TurboMapper nuget package with command below.
1617

1718
```
1819
NuGet\Install-Package TurboMapper
1920
```
20-
### ii. Developer Guide
21+
22+
### ii. Quick Start Example
23+
```csharp
24+
using TurboMapper;
25+
using Microsoft.Extensions.DependencyInjection;
26+
27+
// Setup
28+
var services = new ServiceCollection();
29+
services.AddTurboMapper();
30+
var serviceProvider = services.BuildServiceProvider();
31+
var mapper = serviceProvider.GetService<IMapper>();
32+
33+
// Define models
34+
public class Source
35+
{
36+
public string Name { get; set; }
37+
public int Age { get; set; }
38+
}
39+
40+
public class Target
41+
{
42+
public string Name { get; set; }
43+
public int Age { get; set; }
44+
}
45+
46+
// Map single object
47+
var source = new Source { Name = "John Doe", Age = 30 };
48+
var target = mapper.Map<Source, Target>(source);
49+
50+
// Map collections
51+
var sources = new List<Source>
52+
{
53+
new Source { Name = "Alice", Age = 25 },
54+
new Source { Name = "Bob", Age = 32 }
55+
};
56+
57+
// Map to IEnumerable<T>
58+
IEnumerable<Target> targets = mapper.Map<Source, Target>(sources);
59+
```
60+
61+
### iii. Developer Guide
2162
This comprehensive guide provides detailed information on TurboMapper, covering everything from basic concepts to advanced implementations and troubleshooting guidelines.
2263

2364
Please click on [Developer Guide](https://github.com/CodeShayk/TurboMapper/wiki) for complete details.
2465

2566
## Release Roadmap
26-
This section provides the summary of planned releases with key details about each release.
67+
This section provides the summary of planned releases with key details about each release.
2768

2869
| Release Version | Release Date | Key Features | Backward Compatibility | Primary Focus |
2970
|----------------|--------------|--------------|----------------------|---------------|
30-
| 1.2.0 | October 2025 | Performance improvements (2x+ speed), collection mapping, custom type converters, conditional mapping, transformation functions, configuration validation, improved error messages | ✅ Fully backward compatible | Core improvements, mapping features, custom conversions |
71+
| 1.2.0 | October 2025 | Performance improvements (2x+ speed), enhanced collection mapping API, custom type converters, conditional mapping, transformation functions, configuration validation, improved error messages | ✅ Fully backward compatible | Core improvements, mapping features, custom conversions |
3172
| 1.4.0 | Jan 2026 | Complex nested mapping, circular reference handling, performance diagnostics, generic collection interfaces, interface-to-concrete mapping, dictionary mapping, .NET Standard compatibility | ✅ Fully backward compatible | Advanced mapping, type features, enhanced conversions |
3273
| 2.1.0 | Mid 2026 | Pre-compiled mappings, reverse mapping, async transformations, async collection processing, LINQ expressions, projection support, detailed tracing | ❌ Contains breaking changes (new async methods in IMapper) | Next-gen features, async operations, data access integration |
3374

src/TurboMapper/TurboMapper.csproj

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@
1414
<GeneratePackageOnBuild>True</GeneratePackageOnBuild>
1515
<Copyright>Copyright (c) 2025 Code Shayk</Copyright>
1616
<RepositoryType>git</RepositoryType>
17-
<PackageTags>object-mapper, deep-mapper, shallow-mapper, mapping-library,automapper, turbomapper, objectmapper, mapper, mappinglibrary</PackageTags>
17+
<PackageTags>object-mapper, deep-mapper, mapping-library, automapper, turbomapper, objectmapper, mapper, mappings, mapper-library</PackageTags>
1818
<IncludeSymbols>True</IncludeSymbols>
1919
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
2020
<PackageLicenseFile>LICENSE</PackageLicenseFile>
2121
<GenerateDocumentationFile>True</GenerateDocumentationFile>
2222
<PackageProjectUrl>https://github.com/CodeShayk/TurboMapper/wiki</PackageProjectUrl>
2323
<RepositoryUrl>https://github.com/CodeShayk/TurboMapper</RepositoryUrl>
24-
<PackageReleaseNotes>v1.0.0 - Release of object mapper</PackageReleaseNotes>
25-
<Version>1.0.0</Version>
24+
<PackageReleaseNotes>v1.2.0 - Enhanced core and mapping features including performance improvements (2x+ speed), collection mapping support, custom type converters, conditional mapping, transformation functions, and configuration validation</PackageReleaseNotes>
25+
<Version>1.2.0</Version>
2626
<PackageRequireLicenseAcceptance>True</PackageRequireLicenseAcceptance>
2727
<AssemblyName>TurboMapper</AssemblyName>
2828
</PropertyGroup>

tests/TurboMapper.Tests/IntegrationTests.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
11
using Microsoft.Extensions.DependencyInjection;
2-
using System;
3-
using System.Collections.Generic;
42

53
namespace TurboMapper.Tests
64
{

tests/TurboMapper.Tests/MapperAdvancedTests.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
using System;
2-
using System.Collections.Generic;
31
using TurboMapper.Impl;
42

53
namespace TurboMapper.Tests

0 commit comments

Comments
 (0)