diff --git a/README.md b/README.md index 9676ba1..28cb498 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,19 @@ # 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** @@ -16,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. @@ -24,3 +39,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) +