Skip to content

Commit 2e5cbb6

Browse files
committed
docs: Improve Readme.md for v1
1 parent fefc9d4 commit 2e5cbb6

6 files changed

Lines changed: 73 additions & 1 deletion

File tree

Docs/readme/template-nuget.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@
66
{operators}
77
{configuration}
88
{testing}
9+
{demos}
910
{limitations}
1011
{potential}

Docs/readme/template.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,6 @@
88
{operators}
99
{configuration}
1010
{testing}
11+
{demos}
1112
{limitations}
1213
{potential}

Neomaster.JsonToLinq.ReadmeBuilder/Program.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
.InsertReadmeTemplate("operators")
1717
.InsertReadmeTemplate("configuration")
1818
.InsertReadmeTemplate("testing")
19+
.InsertReadmeTemplate("demos")
1920
.InsertReadmeTemplate("limitations")
2021
.InsertReadmeTemplate("potential")
2122
;
@@ -29,6 +30,7 @@
2930
.InsertReadmeTemplate("operators")
3031
.InsertReadmeTemplate("configuration")
3132
.InsertReadmeTemplate("testing")
33+
.InsertReadmeTemplate("demos")
3234
.InsertReadmeTemplate("limitations")
3335
.InsertReadmeTemplate("potential")
3436
.Replace(@"`\|`", "`|`")

Neomaster.JsonToLinq/Neomaster.JsonToLinq.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<NoWarn>$(NoWarn);IDE0079</NoWarn>
1010
<PackageId>JsonToLinq</PackageId>
1111
<PackageIcon>logo.png</PackageIcon>
12-
<Version>1.0.0-rc917</Version>
12+
<Version>1.0.0-rc920</Version>
1313
<Authors>Neomaster</Authors>
1414
<Company>Neomaster</Company>
1515
<Copyright>Copyright © 2026 Neomaster</Copyright>

readme-nuget.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -302,6 +302,40 @@ Unit tests cover:
302302

303303
Full unit test coverage will be relevant after the library has been used in real projects.
304304

305+
## 🔬 Demos and Experiments<a name="demos"/>
306+
307+
This repository includes the [JsonToLinq.Demo][demo-project] project with **working examples**.
308+
You are welcome to submit a PR with your own examples, bug reports, or new features.
309+
**To describe a filter, use the following notation:**
310+
311+
### 🔤 Filter Notation
312+
313+
#### Syntax
314+
```
315+
expr = logic[expr(, expr)*]
316+
```
317+
- `expr` - a single rule or a combination of rules
318+
- `logic` - an operator used to combine multiple rules, e.g. `&&`, `&`, `||`, `|`, or a custom one
319+
320+
#### Examples
321+
1. `&&[x = null]`
322+
1. `&&[a < 0, b > 0]`
323+
1. `&&[x = null, ||[a < 0, b > 0]]`
324+
325+
### 💻 Demo Project
326+
327+
This project provides examples of working with **EF Core** and a **PostgreSQL database**.
328+
329+
🧪 A real database is used instead of in-memory storage, ensuring clean and realistic experiments.
330+
331+
You can add your own examples with other databases or ORMs via a PR.
332+
333+
▶️ Before running the demos, select the first menu item, **Prepare Data**, to apply migrations and populate the tables with test data.
334+
335+
[demo-project]: https://github.com/neomasterhub/Neomaster.JsonToLinq/tree/master/Neomaster.JsonToLinq.Demo
336+
337+
![Demo project](https://github.com/neomasterhub/Neomaster.JsonToLinq/blob/master/Docs/img/demo-project.png?raw=true "Demo project")
338+
305339
## 🚧 Limitations<a name="limitations"/>
306340

307341
1. **No IDE syntax highlighting for JSON filter arguments in LINQ methods**

readme.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -318,6 +318,40 @@ Unit tests cover:
318318

319319
Full unit test coverage will be relevant after the library has been used in real projects.
320320

321+
## 🔬 Demos and Experiments<a name="demos"/>
322+
323+
This repository includes the [JsonToLinq.Demo][demo-project] project with **working examples**.
324+
You are welcome to submit a PR with your own examples, bug reports, or new features.
325+
**To describe a filter, use the following notation:**
326+
327+
### 🔤 Filter Notation
328+
329+
#### Syntax
330+
```
331+
expr = logic[expr(, expr)*]
332+
```
333+
- `expr` - a single rule or a combination of rules
334+
- `logic` - an operator used to combine multiple rules, e.g. `&&`, `&`, `||`, `|`, or a custom one
335+
336+
#### Examples
337+
1. `&&[x = null]`
338+
1. `&&[a < 0, b > 0]`
339+
1. `&&[x = null, ||[a < 0, b > 0]]`
340+
341+
### 💻 Demo Project
342+
343+
This project provides examples of working with **EF Core** and a **PostgreSQL database**.
344+
345+
🧪 A real database is used instead of in-memory storage, ensuring clean and realistic experiments.
346+
347+
You can add your own examples with other databases or ORMs via a PR.
348+
349+
▶️ Before running the demos, select the first menu item, **Prepare Data**, to apply migrations and populate the tables with test data.
350+
351+
[demo-project]: https://github.com/neomasterhub/Neomaster.JsonToLinq/tree/master/Neomaster.JsonToLinq.Demo
352+
353+
![Demo project](https://github.com/neomasterhub/Neomaster.JsonToLinq/blob/master/Docs/img/demo-project.png?raw=true "Demo project")
354+
321355
## 🚧 Limitations<a name="limitations"/>
322356

323357
1. **No IDE syntax highlighting for JSON filter arguments in LINQ methods**

0 commit comments

Comments
 (0)