Updating package publishing, finishing off docs (#10)

mattwhitfield · Dec 30, 2022 · 9f48efb · 9f48efb
1 parent 4a67828
commit 9f48efb
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 9 deletions.
diff --git 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
@@ -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
@@ -35,7 +35,7 @@ <h1><a href="{{ "/" | absolute_url }}"><img src="{{ "/assets/full_logo.png" | re
         <p class="view">
 		Get the library via nuget:
 		<ul>
-		<li>TO-DO</li>
+		<li><a href="https://www.nuget.org/packages/SequelFilter">nuget package</a></li>
 		</ul>
 		</p>
 

diff --git 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
@@ -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
@@ -12,6 +12,7 @@
     <RepositoryUrl>https://github.com/mattwhitfield/SequelFilter</RepositoryUrl>
     <PackageIcon>nuget_logo.png</PackageIcon>
     <PackageReadmeFile>README.md</PackageReadmeFile>
+    <PackageLicenseExpression> MIT</PackageLicenseExpression>
   </PropertyGroup>
 
   <ItemGroup>