From fbaf6d108f67dfd06323778874f1e8d139dee515 Mon Sep 17 00:00:00 2001 From: Logan-kwan <114600042+Logan-kwan@users.noreply.github.com> Date: Tue, 11 Oct 2022 16:24:37 -0700 Subject: [PATCH 1/2] Update README.md docs(global): Added "The Problem" and "The Solution" to README.MD README.MD now has headers The Problem and The Solution with relevant information from the YouTube video "React Email Final Demo | Google Summer of Code 2022 | GSoC'22 | SCoRe Lab - Leopards Lab" --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 9676ba1..838740e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,16 @@ # react-email + +## The Problem + +Modern-day web browsers are pretty standardized and come with a certain guarantee that if a web page works in one browser, it will work in another web browser too except for a few minor cases. However, this is not true for email clients yet. + +The developer community is thus aligned to certain tricks and hacks to make sure that emails sent are properly rendered by these different email clients. There is no such package that solves this problem of creating responsive emails easily which can also handle cross browsers and clients compatibility issues. + +## The Solution + +The end goal will be to implement a Reach-based component and utility methods-based lightweight library to provide a common interface for email building that users can install and use to build clean and responsive emails easily. + ## How to install **Using NPM** @@ -24,3 +35,4 @@ We try to be the community backed up-to-date solution one can depend on and cont - [https://www.npmjs.com/package/react-email-components](https://www.npmjs.com/package/react-email-components) - [https://mjml.io/getting-started/1](https://mjml.io/getting-started/1) - [https://github.com/ovrsea/medium-articles/tree/master/react-email-templates](https://github.com/ovrsea/medium-articles/tree/master/react-email-templates) + From 3747cd29d9d35a9a3af6e0744721fb31dd0e4609 Mon Sep 17 00:00:00 2001 From: Logan-kwan <114600042+Logan-kwan@users.noreply.github.com> Date: Tue, 18 Oct 2022 08:39:51 -0700 Subject: [PATCH 2/2] fix(docs): README.md follows yarn prettier rules errors with line breaks and such caused yarn prettier to throw an error. --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 838740e..28cb498 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,16 @@ ## The Problem -Modern-day web browsers are pretty standardized and come with a certain guarantee that if a web page works in one browser, it will work in another web browser too except for a few minor cases. However, this is not true for email clients yet. +Modern-day web browsers are pretty standardized and come with a certain guarantee that if a web page works in one browser, it will work in another web browser too +except for a few minor cases. However, this is not true for email clients yet. -The developer community is thus aligned to certain tricks and hacks to make sure that emails sent are properly rendered by these different email clients. There is no such package that solves this problem of creating responsive emails easily which can also handle cross browsers and clients compatibility issues. +The developer community is thus aligned to certain tricks and hacks to make sure that emails sent are properly rendered by these different email clients. There is +no such package that solves this problem of creating responsive emails easily which can also handle cross browsers and clients compatibility issues. ## The Solution -The end goal will be to implement a Reach-based component and utility methods-based lightweight library to provide a common interface for email building that users can install and use to build clean and responsive emails easily. +The end goal will be to implement a Reach-based component and utility methods-based lightweight library to provide a common interface for email building that users +can install and use to build clean and responsive emails easily. ## How to install @@ -27,7 +30,8 @@ yarn add @leopardslab/react-email ## Inspiration -The idea of a React Component Library for Emails is not novel. There have been other implementations around for a while and we were inspired a lot by these solutions and many other generic Component Libraries. Following are a few of the amazing other implementations. +The idea of a React Component Library for Emails is not novel. There have been other implementations around for a while and we were inspired a lot by these +solutions and many other generic Component Libraries. Following are a few of the amazing other implementations. We try to be the community backed up-to-date solution one can depend on and contribute back, request features & seek help.