From b62e9526553b1c5862cad3b36f7b76b270b5c066 Mon Sep 17 00:00:00 2001 From: David Snelling Date: Thu, 19 Jun 2025 16:02:55 -0700 Subject: [PATCH] **docs: update cloud deployment documentation with detailed npm scripts** ### Changes: - Expanded cloud deployment section in `README.md`: - Added detailed npm scripts for deploying to AWS, Google Cloud, and Cloudflare. - Described script usage for each cloud platform. - Included instructions for configuring environment variables in `cloud-wrapper/.env`. - Linked to the Cloud Wrapper README for additional setup and API documentation. ### Purpose: Improved clarity and usability of cloud deployment instructions by providing specific npm script commands and configuration guidance. This helps streamline the deployment process for users across multiple cloud platforms. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index de3cbc37..9c579a5f 100644 --- a/README.md +++ b/README.md @@ -812,7 +812,25 @@ Key features of the cloud wrapper: - Configurable via environment variables - Deployment scripts for AWS, Google Cloud, and Cloudflare -To get started with cloud deployment, see the [Cloud Wrapper README](cloud-wrapper/README.md). +### Deploying to the Cloud + +You can deploy the cloud wrapper to various cloud platforms using the following npm scripts from the root directory: + +```bash +# Deploy to AWS Lambda and API Gateway +npm run deploy:cloud:aws + +# Deploy to Google Cloud Run +npm run deploy:cloud:gcp + +# Deploy to Cloudflare Workers +npm run deploy:cloud:cloudflare + +# Show available deployment options +npm run deploy:cloud +``` + +Before deploying, make sure to configure the appropriate environment variables in the `cloud-wrapper/.env` file. See the [Cloud Wrapper README](cloud-wrapper/README.md) for detailed configuration instructions and API documentation. ## 🔗 Related Projects