Skip to content

Commit 1428b72

Browse files
committed
Readme update
1 parent d2de35f commit 1428b72

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 INFRAGISTICS
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

ReadMe.md

Lines changed: 1 addition & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,12 @@ A .NET 8, .NET 9 library for dynamic, strongly-typed query building and executio
44

55
[![NuGet](https://img.shields.io/nuget/v/Infragistics.QueryBuilder.Executor.svg)](https://www.nuget.org/packages/Infragistics.QueryBuilder.Executor/)
66

7-
---
8-
97
## Installation
108

119
Install via NuGet Package Manager:
1210

1311
`dotnet add package Infragistics.QueryBuilder.Executor`
1412

15-
16-
---
17-
1813
## Features
1914

2015
- **Dynamic Query Execution**: Compose and execute queries at runtime using a flexible object model.
@@ -23,8 +18,6 @@ Install via NuGet Package Manager:
2318
- **SQL Generation**: Generate SQL from the query model for diagnostics or analysis.
2419
- **ASP.NET Core Integration**: Easily expose query endpoints.
2520

26-
---
27-
2821
## Getting Started
2922

3023
### 1. Register the QueryBuilder Service
@@ -33,45 +26,31 @@ In your `Startup.cs` or Program configuration:
3326

3427
`services.AddQueryBuilder<MyDbContext, MyResultDto>();`
3528

36-
3729
### 2. Expose a Query Endpoint
3830

3931
`app.UseEndpoints(endpoints => { endpoints.UseQueryBuilder<MyDbContext, MyResultDto>("/api/query"); });`
4032

41-
4233
### 3. Example Query Payload
4334

4435
`{ "Entity": "Users", "ReturnFields": ["Id", "Name"], "Operator": "And", "FilteringOperands": [ { "FieldName": "IsActive", "Condition": { "Name": "equals" }, "SearchVal": true } ] }`
4536

46-
4737
### 4. Generate SQL (Optional)
4838

4939
`var sql = SqlGenerator.GenerateSql(query);`
5040

51-
52-
---
53-
5441
## Query Model
5542

5643
- **Query**: Describes the entity, fields, logical operator, and filters.
5744
- **QueryFilter**: Represents a filter or group of filters.
5845
- **QueryFilterCondition**: Specifies the comparison type (e.g., equals, contains).
5946

60-
---
61-
6247
## Dependencies
6348

6449
- .NET 8 or .NET 9
6550
- Microsoft.EntityFrameworkCore
6651
- AutoMapper
6752
- builder.Services.AddControllers().AddNewtonsoftJson(o => o.SerializerSettings.ReferenceLoopHandling = ReferenceLoopHandling.Ignore) for working SwaggerUI
6853

69-
---
70-
7154
## License
7255

73-
This package is provided as-is for public and demonstration use.
74-
75-
---
76-
77-
*For more details, see the source code or contact the maintainers.*
56+
[MIT](/LICENSE).

0 commit comments

Comments
 (0)