add readme to project

Author: Antony Bailey

CSQLY.CLI/CSQLY.CLI.csproj

@@ -9,6 +9,17 @@
     <RootNamespace>CSQLY.CLI</RootNamespace>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
     <NoWarn>NU1701</NoWarn>
+    <PackageId>CSQLY.CLI</PackageId>
+    <Version>0.1.0</Version>
+    <Authors>CSQLY Team</Authors>
+    <Description>Command-line interface for CSQLY, a simplified query language for databases using YAML</Description>
+    <PackageTags>sql;yaml;database;query;cli</PackageTags>
+    <PackageLicenseExpression>MIT</PackageLicenseExpression>
+    <PackageProjectUrl>https://github.com/Standard-Query-Language/CSQLY</PackageProjectUrl>
+    <RepositoryUrl>https://github.com/Standard-Query-Language/CSQLY.git</RepositoryUrl>
+    <PackAsTool>true</PackAsTool>
+    <ToolCommandName>csqly</ToolCommandName>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
   <ItemGroup>
@@ -19,4 +30,8 @@
     <PackageReference Include="System.CommandLine" Version="2.0.0-beta4.22272.1" />
   </ItemGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
 </Project>

CSQLY.CLI/README.md

@@ -0,0 +1,63 @@
+# CSQLY Command Line Interface
+
+CSQLY CLI is a command-line tool for executing YAML-based SQL queries against various database systems.
+
+## Installation
+
+```bash
+dotnet tool install --global CSQLY.CLI
+```
+
+## Usage
+
+```bash
+csqly --file <path-to-yaml-file> --connection <connection-string> --type <database-type>
+```
+
+Abbreviated options:
+
+```bash
+csqly -f <path-to-yaml-file> -c <connection-string> -t <database-type>
+```
+
+## Options
+
+| Option | Abbreviation | Description |
+|--------|--------------|-------------|
+| `--file` | `-f` | Path to the YAML query file |
+| `--connection` | `-c` | Database connection string |
+| `--type` | `-t` | Database type (sqlite, mysql, postgres, sqlserver, oracle) |
+| `--help` | `-h` | Show help information |
+| `--version` | `-v` | Show version information |
+
+## Examples
+
+### SQLite Example
+
+```bash
+csqly -f query.yaml -c "Data Source=mydb.sqlite" -t sqlite
+```
+
+### MySQL Example
+
+```bash
+csqly -f query.yaml -c "Server=localhost;Database=mydb;User ID=user;Password=password;" -t mysql
+```
+
+## YAML Query Example
+
+```yaml
+select:
+  columns:
+    - id
+    - name
+    - email
+  from: users
+  where:
+    active: true
+  limit: 10
+```
+
+## More Information
+
+For full documentation, visit the [GitHub repository](https://github.com/Standard-Query-Language/CSQLY).

CSQLY/CSQLY.csproj

@@ -18,8 +18,13 @@
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/Standard-Query-Language/CSQLY</PackageProjectUrl>
     <RepositoryUrl>https://github.com/Standard-Query-Language/CSQLY.git</RepositoryUrl>
+    <PackageReadmeFile>README.md</PackageReadmeFile>
   </PropertyGroup>
 
+  <ItemGroup>
+    <None Include="README.md" Pack="true" PackagePath="\" />
+  </ItemGroup>
+
   <!-- Optional: Add references to database providers that you want to support out of the box -->
   <!--
   <ItemGroup>

CSQLY/README.md

@@ -0,0 +1,21 @@
+# CSQLY - SQL with YAML
+
+CSQLY is a simplified query language for multiple databases that allows you to write database queries in YAML format and execute them against different database engines.
+
+## Features
+
+- Write database queries in easy-to-read YAML format
+- Support for multiple database types:
+  - SQLite
+  - MySQL/MariaDB
+  - PostgreSQL
+  - Oracle
+  - Microsoft SQL Server
+- Simplified query syntax with type safety
+- Connection pooling and management
+- Easily extensible architecture
+
+## Installation
+
+### Package Manager Console
+