From 9f48efbafd9c91d79de74df72ef10470f4a71e76 Mon Sep 17 00:00:00 2001 From: Matt Whitfield Date: Fri, 30 Dec 2022 15:49:49 +0000 Subject: [PATCH] Updating package publishing, finishing off docs (#10) --- .github/workflows/CI.yml | 2 +- README.md | 6 +++--- docs/_layouts/default.html | 2 +- docs/contributing.md | 10 +++++++++- docs/index.md | 6 +++--- src/SequelFilter/SequelFilter.csproj | 1 + 6 files changed, 18 insertions(+), 9 deletions(-) diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml index 00f2a7d..b2ed985 100644 --- a/.github/workflows/CI.yml +++ b/.github/workflows/CI.yml @@ -71,7 +71,7 @@ jobs: with: fetch-depth: '0' - name: Setup NuGet - uses: NuGet/setup-nuget@v1.0.5 + uses: NuGet/setup-nuget@v1.1.1 - run: | ./.github/workflows/AutoVersion.ps1 shell: pwsh diff --git a/README.md b/README.md index 62c7715..cba8d8c 100644 --- a/README.md +++ b/README.md @@ -12,9 +12,9 @@ Sequel Filter is a C# library that allows for filtering using a SQL-like syntax. ## Grammar Features ✍ * Basic comparisons with support for loose type matching -* Combinational logic with AND / OR -* Support for IN, LIKE, BETWEEN, IS NULL SQL operators -* Support for searching child enumerables with HAS_NONE, HAS_ANY, HAS_SINGLE +* Combinational logic with `AND` / `OR` +* Support for `IN`, `LIKE`, `BETWEEN` and `IS NULL` SQL operators +* Support for searching child enumerables with `HAS_NONE`, `HAS_ANY`, `HAS_SINGLE` # Documentation 📖 diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 0f3f059..9ed73d8 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -35,7 +35,7 @@

Get the library via nuget:

diff --git a/docs/contributing.md b/docs/contributing.md index a94ecc2..8dbff6e 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -15,4 +15,12 @@ I am really excited to see what you come up with to take this project forward - ## Solution Layout 🗃 -** info coming ** +The solution is fairly simple, consisting of just the library and it's tests. + +In the main project, the Irony based grammary and main entry points are in the root folder. + +The 'Comparison' folder contains the code that facilitates loosely-typed value comparisons. + +The 'NodeTransforms' folder contains the code responsible for converting parsed syntax trees into executable delegates. + +The 'Resolvers' folder contains the various resolvers that allow field references to be resolved from input object. diff --git a/docs/index.md b/docs/index.md index 27f5366..460f2bd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -15,9 +15,9 @@ Sequel Filter is a C# library that allows for filtering using a SQL-like syntax. ## Grammar Features ✍ * Basic comparisons with support for loose type matching -* Combinational logic with AND / OR -* Support for IN, LIKE, BETWEEN, IS NULL SQL operators -* Support for searching child enumerables with HAS_NONE, HAS_ANY, HAS_SINGLE +* Combinational logic with `AND` / `OR` +* Support for `IN`, `LIKE`, `BETWEEN` and `IS NULL` SQL operators +* Support for searching child enumerables with `HAS_NONE`, `HAS_ANY`, `HAS_SINGLE` # Documentation Sections 📖 diff --git a/src/SequelFilter/SequelFilter.csproj b/src/SequelFilter/SequelFilter.csproj index ba1c7fd..6e66a7d 100644 --- a/src/SequelFilter/SequelFilter.csproj +++ b/src/SequelFilter/SequelFilter.csproj @@ -12,6 +12,7 @@ https://github.com/mattwhitfield/SequelFilter nuget_logo.png README.md + MIT