chore(readme): adjust README.md format

cofin · cofin · commit c7190eaf7b9a · 2025-01-15T14:53:17.000Z
diff --git a/README.md b/README.md
@@ -6,30 +6,30 @@ SQLSpec is an experimental Python library designed to streamline and modernize y
 
 **Note**: SQLSpec is currently under active development and the API is subject to change.  It is not yet ready for production use.  Contributions are welcome!
 
-### Core Features (Planned but subject to change, removal or redesign)
+## Core Features (Planned but subject to change, removal or redesign)
 
 - **Consistent Database Session Interface**: Provides a consistent connectivity interface for interacting with one or more database systems, including SQLite, Postgres, DuckDB, MySQL, Oracle, SQL Server, Spanner, BigQuery, and more.
 - **Emphasis on RAW SQL and Minimal Abstractions and Performance**: SQLSpec is a library for working with SQL in Python.  It's goals are to offer minimal abstractions between the user and the database.  It does not aim to be an ORM library.
-- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msqgspec, Attrs, etc.
+- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msqspec, Attrs, etc.
 - **Extensible Design**: Easily add support for new database dialects or extend existing functionality to meet your specific needs.  Easily add support for async and sync database drivers.
 - **Minimal Dependencies**: SQLSpec is designed to be lightweight and can run on it's own or with other libraries such as `litestar`, `fastapi`, `flask` and more.  (Contributions welcome!)
 - **Dynamic Query Manipulation**: Easily apply filters to pre-defined queries with a fluent, Pythonic API. Safely manipulate queries without the risk of SQL injection.
 - **Dialect Validation and Conversion**: Use `sqlglot` to validate your SQL against specific dialects and seamlessly convert between them.
 - **Support for Async and Sync Database Drivers**: SQLSpec supports both async and sync database drivers, allowing you to choose the style that best fits your application.
 
-### What SQLSpec Is Not (Yet)
+## What SQLSpec Is Not (Yet)
 
 SQLSpec is a work in progress. While it offers a solid foundation for modern SQL interactions, it does not yet include every feature you might find in a mature ORM or database toolkit. The focus is on building a robust, flexible core that can be extended over time.
 
-### Inspiration and Future Direction
+## Inspiration and Future Direction
 
 SQLSpec originally drew inspiration from features found in the `aiosql` library.  This is a great library for working with and executed SQL stored in files.  It's unclear how much of an overlap there will be between the two libraries, but it's possible that some features will be contributed back to `aiosql` where appropriate.
 
-### Current Focus: Universal Connectivity
+## Current Focus: Universal Connectivity
 
 The primary goal at this stage is to establish a **native connectivity interface** that works seamlessly across all supported database environments. This means you can connect to any of the supported databases using a consistent API, regardless of the underlying driver or dialect.
 
-### Adapters: Completed, In Progress, and Planned
+## Adapters: Completed, In Progress, and Planned
 
 This list is not final. If you have a driver you'd like to see added, please open an issue or submit a PR!
 
@@ -51,9 +51,9 @@ This list is not final. If you have a driver you'd like to see added, please ope
 | [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️ Planned |
 | [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️ Planned |
 | [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️ Planned |
-| [`snowflake`](https://docs.snowflake.com)
+| [`snowflake`](https://docs.snowflake.com)                                                                    | MySQL      | Sync    | 🗓️ Planned |
 
-### Proposed Project Structure
+## Proposed Project Structure
 
 - `sqlspec/`:
     - `adapters/`: Contains all database drivers and associated configuration.
@@ -68,7 +68,7 @@ This list is not final. If you have a driver you'd like to see added, please ope
     - `exceptions.py`: Contains custom exceptions for SQLSpec.
     - `typing.py`: Contains type hints, type guards and several facades for optional libraries that are not required for the core functionality of SQLSpec.
 
-### Get Involved
+## Get Involved
 
 SQLSpec is an open-source project, and contributions are welcome! Whether you're interested in adding support for new databases, improving the query interface, or simply providing feedback, your input is valuable.
 
diff --git a/docs/PYPI_README.md b/docs/PYPI_README.md
@@ -6,30 +6,30 @@ SQLSpec is an experimental Python library designed to streamline and modernize y
 
 **Note**: SQLSpec is currently under active development and the API is subject to change.  It is not yet ready for production use.  Contributions are welcome!
 
-### Core Features (Planned but subject to change, removal or redesign)
+## Core Features (Planned but subject to change, removal or redesign)
 
 - **Consistent Database Session Interface**: Provides a consistent connectivity interface for interacting with one or more database systems, including SQLite, Postgres, DuckDB, MySQL, Oracle, SQL Server, Spanner, BigQuery, and more.
 - **Emphasis on RAW SQL and Minimal Abstractions and Performance**: SQLSpec is a library for working with SQL in Python.  It's goals are to offer minimal abstractions between the user and the database.  It does not aim to be an ORM library.
-- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msqgspec, Attrs, etc.
+- **Type-Safe Queries**: Quickly map SQL queries to typed objects using libraries such as Pydantic, Msqspec, Attrs, etc.
 - **Extensible Design**: Easily add support for new database dialects or extend existing functionality to meet your specific needs.  Easily add support for async and sync database drivers.
 - **Minimal Dependencies**: SQLSpec is designed to be lightweight and can run on it's own or with other libraries such as `litestar`, `fastapi`, `flask` and more.  (Contributions welcome!)
 - **Dynamic Query Manipulation**: Easily apply filters to pre-defined queries with a fluent, Pythonic API. Safely manipulate queries without the risk of SQL injection.
 - **Dialect Validation and Conversion**: Use `sqlglot` to validate your SQL against specific dialects and seamlessly convert between them.
 - **Support for Async and Sync Database Drivers**: SQLSpec supports both async and sync database drivers, allowing you to choose the style that best fits your application.
 
-### What SQLSpec Is Not (Yet)
+## What SQLSpec Is Not (Yet)
 
 SQLSpec is a work in progress. While it offers a solid foundation for modern SQL interactions, it does not yet include every feature you might find in a mature ORM or database toolkit. The focus is on building a robust, flexible core that can be extended over time.
 
-### Inspiration and Future Direction
+## Inspiration and Future Direction
 
 SQLSpec originally drew inspiration from features found in the `aiosql` library.  This is a great library for working with and executed SQL stored in files.  It's unclear how much of an overlap there will be between the two libraries, but it's possible that some features will be contributed back to `aiosql` where appropriate.
 
-### Current Focus: Universal Connectivity
+## Current Focus: Universal Connectivity
 
 The primary goal at this stage is to establish a **native connectivity interface** that works seamlessly across all supported database environments. This means you can connect to any of the supported databases using a consistent API, regardless of the underlying driver or dialect.
 
-### Adapters: Completed, In Progress, and Planned
+## Adapters: Completed, In Progress, and Planned
 
 This list is not final. If you have a driver you'd like to see added, please open an issue or submit a PR!
 
@@ -51,9 +51,9 @@ This list is not final. If you have a driver you'd like to see added, please ope
 | [`spanner`](https://googleapis.dev/python/spanner/latest/index.html)                                         | Spanner    | Sync    | 🗓️ Planned |
 | [`sqlserver`](https://docs.microsoft.com/en-us/sql/connect/python/pyodbc/python-sql-driver-for-pyodbc?view=sql-server-ver16) | SQL Server | Sync    | 🗓️ Planned |
 | [`mysql`](https://dev.mysql.com/doc/connector-python/en/connector-python-api-mysql-connector-python.html)     | MySQL      | Sync    | 🗓️ Planned |
-| [`snowflake`](https://docs.snowflake.com)
+| [`snowflake`](https://docs.snowflake.com)                                                                    | MySQL      | Sync    | 🗓️ Planned |
 
-### Proposed Project Structure
+## Proposed Project Structure
 
 - `sqlspec/`:
     - `adapters/`: Contains all database drivers and associated configuration.
@@ -68,7 +68,7 @@ This list is not final. If you have a driver you'd like to see added, please ope
     - `exceptions.py`: Contains custom exceptions for SQLSpec.
     - `typing.py`: Contains type hints, type guards and several facades for optional libraries that are not required for the core functionality of SQLSpec.
 
-### Get Involved
+## Get Involved
 
 SQLSpec is an open-source project, and contributions are welcome! Whether you're interested in adding support for new databases, improving the query interface, or simply providing feedback, your input is valuable.
 
