Skip to content

Commit 6c0a6e5

Browse files
committed
feat (vs-code): new description and new README
1 parent b2469c5 commit 6c0a6e5

File tree

2 files changed

+34
-3
lines changed

2 files changed

+34
-3
lines changed

packages/vs-code-extension/README.md

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1-
# react-email preview
1+
![React email cover](https://react.email/static/covers/react-email.png)
22

3-
A easy way to have a preview of an email written with react-email from your editor.
3+
<div align="center"><strong>React Email Preview for VS Code</strong></div>
4+
<div align="center">The next generation of writing emails.<br />High-quality, unstyled components for creating emails.</div>
5+
<br />
6+
<div align="center">
7+
<a href="https://react.email">Website</a>
8+
<span> · </span>
9+
<a href="https://github.com/resendlabs/react-email">GitHub</a>
10+
<span> · </span>
11+
<a href="https://react.email/discord">Discord</a>
12+
</div>
13+
14+
A easy way to have a preview of an email written with [react-email](https://github.com/resendlabs/react-email) from your editor.
15+
16+
## How to use?
17+
18+
To use it, you will need to run the command from the command pallete, or you will need
19+
to use the keybinding that is by default `CTRL + SHIFT + E` (or `CMD + SHIFT + E` for Mac).
20+
21+
Once you run the command, a split will appear with a welcome message, once you focus a email
22+
written with react-email, it will auto-detect and render it automatically for you showing a preview of
23+
how it looks.
24+
25+
## Found a bug?
26+
27+
If you have found a bug, even if small, please open a issue [here](https://github.com/resendlabs/react-email/issues).
28+
We want for `react-email` to bring the best developer experience possible and your feedback is very welcome.
29+
30+
## What is react-email?
31+
32+
React Email is a collection of high-quality, unstyled components for creating beautiful emails using React and TypeScript. It reduces the pain of coding responsive emails with dark mode support. It also takes care of inconsistencies between Gmail, Outlook, and other email clients for you.
33+
34+
Find out more [here](https://react.email/).

packages/vs-code-extension/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "vs-code-extension",
33
"displayName": "react-email preview",
4-
"description": "A easy way to view the preview of a react-email email from your editor",
4+
"description": "A easy way to view the preview of a email made with react-email from your editor",
55
"version": "0.0.1",
66
"license": "MIT",
77
"publishConfig": {

0 commit comments

Comments
 (0)