Updating docs and readme due to missing SSL/PG pool configuration informations

[z4nr34l]

This pull request updates documentation across multiple files to improve clarity, consistency, and support for secure database connections. The main changes include standardizing references from "Postgres" to "PostgreSQL," updating configuration instructions to use the new poolConfig option for database connections, and adding comprehensive guidance for SSL certificate handling using base64 encoding. These changes help users correctly configure the Stripe Sync Engine for secure deployments and make the documentation easier to follow.

Documentation consistency and clarity:

• All references to "Postgres" have been updated to "PostgreSQL" in README.md, docs/index.md, docs/typescript.md, docs/docker.md, and packages/fastify-app/README.md for accuracy and consistency. [1] [2] [3] [4] [5]
• Improved phrasing and formatting in contributing guidelines and documentation commands for better readability, including shell command blocks and deployment instructions. [1] [2] [3] [4]

Configuration and setup improvements:

• Deprecated the databaseUrl and maxPostgresConnections options in favor of a new poolConfig object for configuring PostgreSQL connections, including support for SSL parameters, in both TypeScript and Edge Function usage guides. [1] [2] [3]
• Updated environment variable and endpoint documentation to reflect new SSL options (PG_SSL_CONFIG_ENABLED, PG_SSL_CA, etc.) and clarified their usage in Docker and Edge Function deployments. [1] [2] [3]

SSL certificate handling:

• Added detailed instructions for encoding CA certificates in base64 format and passing them as environment variables to Docker containers and Supabase Edge Functions, including example commands and usage notes. [1] [2] [3]

Minor documentation fixes:

• Updated image references and descriptions to match the new naming convention and database terminology. [1] [2]
• Improved section headers, command formatting, and example usage blocks throughout the documentation for better developer experience. [1] [2] [3] [4]

These updates ensure users have clear, secure, and up-to-date instructions for deploying and configuring the Stripe Sync Engine in various environments.

closes #194

[z4nr34l]

Now the docs are RIPE 🥳

[kevcodez]

Looks great, thanks!

[github-actions]

🎉 This PR is included in version 0.45.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀