Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(docs): Updated README.md #128

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix(docs): Updated README.md #128

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fbaf6d1
Update README.md
Logan-kwan Oct 11, 2022
3747cd2
fix(docs): README.md follows yarn prettier rules
Logan-kwan Oct 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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**
Expand All @@ -16,11 +30,13 @@ 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.

- [https://github.com/lang-ai/react-emails](https://github.com/lang-ai/react-emails)
- [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)