From a6dd476b6a37bb4f14bc68413684bbda425cf2ae Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Thu, 2 May 2024 15:40:37 -0700 Subject: [PATCH 1/6] Update readme branding --- README.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 25e3da3..e55a424 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,16 @@ -

- - - -

Power automated communication that people like to receive.

-

+ + + + + +

Say more, more powerfully

 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-node/) [![ci](https://github.com/customerio/customerio-node/actions/workflows/main.yml/badge.svg)](https://github.com/customerio/customerio-node/actions/workflows/main.yml) -# Customer.io Node +# Customer.io NodeJS -A node client for the Customer.io [REST API](https://customer.io/docs/api/). +A node client for the Customer.io Journeys [REST API](https://customer.io/docs/api/). If you're new to Customer.io, we recommend that you integrate with our [Data Pipelines JavaScript client](https://github.com/customerio/cdp-analytics-js) instead. ## Alternative Node runtimes From fd2b68f0c4a697e0b8ac0aca71e0cc371c2fc82a Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Thu, 2 May 2024 15:54:42 -0700 Subject: [PATCH 2/6] per docs-337 --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index e55a424..b3300d3 100644 --- a/README.md +++ b/README.md @@ -305,7 +305,7 @@ Create a new `SendEmailRequest` object containing: - `to`: the email address of your recipients - an `identifiers` object containing the email and/or `id` of your recipient. If the person you reference by email or ID does not exist, Customer.io creates them. - a `message_data` object containing properties that you want reference in your message using Liquid. -- You can also send attachments with your message. Use `attach` to encode attachments. +- You can also send attachments with your message with `attach`, but you need to read the file to a buffer (with `fs.readFileSync`, for example); you cannot attach raw, base64-encoded data directly from a variable. Use `sendEmail` referencing your request to send a transactional message. [Learn more about transactional messages and `SendEmailRequest` properties](https://customer.io/docs/transactional-api). @@ -331,6 +331,8 @@ const request = new SendEmailRequest({ }); // (optional) attach a file to your message. +// Note that you need to read the file to a buffer; +// you can't simply attach raw, base64-encoded data. request.attach("receipt.pdf", fs.readFileSync("receipt.pdf")); api From 09bc035bbd178f8e8a45e4102d2503b5dbd13dab Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Thu, 2 May 2024 16:04:54 -0700 Subject: [PATCH 3/6] try more with the style --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index b3300d3..c215109 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - +
- - + + -

Say more, more powerfully

Say more, more powerfully
+ [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-node/) [![ci](https://github.com/customerio/customerio-node/actions/workflows/main.yml/badge.svg)](https://github.com/customerio/customerio-node/actions/workflows/main.yml) From 57c71b85b4a276bae7eb3080dd694033c891f109 Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Thu, 2 May 2024 16:08:38 -0700 Subject: [PATCH 4/6] trying a bit more style changes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c215109..1e0ae7b 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ - +
- - + +

Say more, more powerfully

Say more, more powerfully
From 5b2d8bdc974dae7b832c67d5260e440c7020470e Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Thu, 2 May 2024 16:15:27 -0700 Subject: [PATCH 5/6] how's this? --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 1e0ae7b..9d84988 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ - - - - - -

Say more, more powerfully

+

+ + + +

Say more, more powerfully

+

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-node/) [![ci](https://github.com/customerio/customerio-node/actions/workflows/main.yml/badge.svg)](https://github.com/customerio/customerio-node/actions/workflows/main.yml) From 4341b59530f7a76abc7cf65498aff6bf05a1c05a Mon Sep 17 00:00:00 2001 From: Chad Glosier Date: Fri, 3 May 2024 08:05:27 -0700 Subject: [PATCH 6/6] remove tagline --- README.md | 1 - 1 file changed, 1 deletion(-) diff --git a/README.md b/README.md index 9d84988..304ba70 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,6 @@ -

Say more, more powerfully

[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blueviolet?logo=gitpod)](https://gitpod.io/#https://github.com/customerio/customerio-node/)