Skip to content

Commit

Permalink
docs: Update documentation (#55)
Browse files Browse the repository at this point in the history
Reorganize header and add migration instructions for 2.2.
  • Loading branch information
skarllot authored Nov 11, 2023
1 parent 506969f commit 31e6527
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
![Abstractions for specifications and query strategies](logos/logo-horizontal-red-black-button-slogan.png "Raiqub Expressions")
# Raiqub Expressions

_Raiqub.Expressions is a library that provides abstractions for creating specifications and query strategies using LINQ expressions. It also supports querying and writing to databases using various providers._

[![Build status](https://github.com/skarllot/Expressions/actions/workflows/dotnet.yml/badge.svg?branch=main)](https://github.com/skarllot/Expressions/actions)
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/skarllot/Expressions/badge)](https://securityscorecards.dev/viewer/?uri=github.com/skarllot/Expressions)
[![Code coverage](https://codecov.io/gh/skarllot/Expressions/branch/main/graph/badge.svg)](https://codecov.io/gh/skarllot/Expressions)
[![Mutation testing badge](https://img.shields.io/endpoint?style=flat&url=https%3A%2F%2Fbadge-api.stryker-mutator.io%2Fgithub.com%2Fskarllot%2FExpressions%2Fmain)](https://dashboard.stryker-mutator.io/reports/github.com/skarllot/Expressions/main)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](https://raw.githubusercontent.com/skarllot/Expressions/master/LICENSE)

_Raiqub.Expressions is a library that provides abstractions for creating specifications and query strategies using LINQ expressions. It also supports querying and writing to databases using various providers._

[🏃 Quickstart](#quickstart)   |   [📗 Guide](#guide)   |   [🔄 Migration](#migration-guide)

<hr />

![Abstractions for specifications and query strategies](https://raw.github.com/skarllot/Expressions/main/logos/logo-horizontal-red-black-button-slogan.png "Raiqub Expressions")

## Features
* Easily define and compose specifications to encapsulate business rules
* Create custom query strategies for flexible and efficient data retrieval
Expand Down Expand Up @@ -362,8 +364,8 @@ If you need to use another ORM library, you will need to implement your own data

## Migration Guide

### Key Changes in 2.0.0
In the Version 2.0.0 release of our library, the `IQueryModel`-related interfaces and classes was renamed to `IQueryStrategy`. These changes are summarized in the table below:
### Key Changes in 2.0
In the version 2.0, the `IQueryModel`-related interfaces and classes was renamed to `IQueryStrategy`. These changes are summarized in the table below:

| V1 | V2 |
|------------------------------------------|---------------------------------------------|
Expand All @@ -376,6 +378,9 @@ We chose to rename these interfaces and classes to use the "Strategy" suffix (`I

It's important to note that the `IEntityQueryStrategy` interface now extends the `IQueryStrategy` interface. This hierarchy reflects the relationship between entity-specific query strategies and general query strategies. You can use this inheritance structure to create custom query strategies that build upon the foundation provided by `IQueryStrategy`.

### Key Changes in 2.2
In the version 2.2, extension methods for `IDbSession` and `IDbQuery` were added to respective interface contract. And `IEntityQueryStrategy` interface no longer extends the `IQueryStrategy` interface.

## Contributing

If something is not working for you or if you think that the source file
Expand Down

0 comments on commit 31e6527

Please sign in to comment.