docs

Author: Antony Bailey

CONTRIBUTING.md

@@ -0,0 +1,91 @@
+# Contributing to CSQLY
+
+Thank you for considering contributing to CSQLY! This document outlines the guidelines for contributing to the project.
+
+## Code of Conduct
+
+This project adheres to a Code of Conduct. By participating, you are expected to uphold this code.
+
+## How Can I Contribute?
+
+### Reporting Bugs
+
+- Check if the bug is already reported in the [Issues](https://github.com/Standard-Query-Language/CSQLY/issues)
+- If not, create a new issue with details:
+  - A clear title
+  - A detailed description
+  - Steps to reproduce
+  - Expected behavior vs. actual behavior
+  - Environment details (OS, .NET version, etc.)
+
+### Suggesting Enhancements
+
+- Check if the enhancement is already suggested in the [Issues](https://github.com/Standard-Query-Language/CSQLY/issues)
+- If not, create a new issue with details:
+  - A clear title
+  - A detailed description explaining the enhancement and its benefits
+  - Any design considerations or implementation details
+
+### Pull Requests
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b feature/amazing-feature`)
+3. Make your changes
+4. Run tests and ensure they pass (`./run_tests.sh` or `run_tests.bat`)
+5. Update documentation if necessary
+6. Commit your changes following our [commit message guidelines](#commit-messages)
+7. Push to your branch (`git push origin feature/amazing-feature`)
+8. Open a Pull Request with a clear description of the changes
+
+## Development Setup
+
+1. Install .NET SDK 9.0 or later
+2. Clone the repository
+3. Run `dotnet restore` to restore dependencies
+4. Run `dotnet build` to build the solution
+5. Run `./run_tests.sh` or `run_tests.bat` to run tests
+
+## Project Structure
+
+- `/CSQLY` - Core library
+- `/CSQLY.Tests` - Unit tests
+- `/CSQLY.CLI` - Command-line interface
+- `/docs` - Documentation
+
+## Coding Guidelines
+
+- Follow C# coding conventions
+- Write unit tests for new features
+- Document public APIs with XML comments
+- Keep code maintainable and readable
+
+## Commit Messages
+
+Follow the [Conventional Commits](https://www.conventionalcommits.org/) specification:
+
+```bash
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer]
+```
+
+Examples:
+
+- `feat(sqlite): add support for BLOB data`
+- `fix(parser): correct handling of null values`
+- `docs(readme): update installation instructions`
+
+## Review Process
+
+Pull requests will be reviewed by maintainers. The review process includes:
+
+- Code review for quality, maintainability, and adherence to project standards
+- Verification that tests pass and coverage is maintained
+- Documentation review if applicable
+- Ensuring the PR addresses a specific issue or enhancement
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the project's MIT License.

README.md

@@ -1,18 +1,34 @@
 # CSQLY - SQL with YAML
 
+[![Build and Test](https://github.com/Standard-Query-Language/CSQLY/actions/workflows/build.yml/badge.svg)](https://github.com/Standard-Query-Language/CSQLY/actions/workflows/build.yml)
+[![NuGet](https://img.shields.io/nuget/v/CSQLY.svg)](https://www.nuget.org/packages/CSQLY/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
 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, MS SQL Server)
-- Simplified query syntax
+- 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
+- Command-line interface for quick queries
 
 ## Installation
 
-Install the CSQLY package from NuGet:
+### Package Manager Console
+
+```
+Install-Package CSQLY
+```
+
+### .NET CLI
 
 ```bash
 dotnet add package CSQLY
@@ -21,7 +37,7 @@ dotnet add package CSQLY
 ## Basic Usage
 
 ```csharp
-using CSQLY;
+using CSQLY.Core;
 using CSQLY.Connectors;
 
 // Create a database connection
@@ -45,9 +61,27 @@ foreach (var row in result)
 }
 ```
 
+## Command-Line Interface
+
+CSQLY also provides a command-line interface for quick queries:
+
+```bash
+# Install the CLI tool
+dotnet tool install --global CSQLY.CLI
+
+# Execute a query from a file
+csqly -f query.yaml -c "Data Source=mydb.sqlite" -t sqlite
+```
+
 ## Documentation
 
-For detailed documentation, visit [our wiki](https://github.com/Standard-Query-Language/CSQLY/wiki).
+For detailed documentation, see:
+
+- [Getting Started](docs/getting-started.md)
+- [Query Syntax](docs/query-syntax.md)
+- [Database Connectors](docs/database-connectors.md)
+- [CLI Usage](docs/cli-usage.md)
+- [API Reference](docs/api-reference.md)
 
 ## Contributing
 
@@ -59,6 +93,8 @@ Contributions are welcome! Please feel free to submit a Pull Request.
 4. Push to the branch (`git push origin feature/amazing-feature`)
 5. Open a Pull Request
 
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed guidelines.
+
 ## License
 
-This project is licensed under the MIT License - see the LICENSE file for details.
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.