Skip to content

Commit

Permalink
feat: update readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
dapandocs committed Jun 27, 2023
1 parent ae0ed19 commit 7fef163
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 21 deletions.
63 changes: 42 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,55 @@
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
<div align="center">

## Getting Started
<h1 align="center">Temp Mail</h1>

First, run the development server:
一键免费部署你的私人 Temp Mail 临时邮箱网页应用。

```bash
npm run dev
# or
yarn dev
# or
pnpm dev
```
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/dapandocs/TempMail&project-name=temp-mail&repository-name=TempMail)

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
![PC主界面](./docs/images/pc.png)
![手机主界面](./docs/images/mobile.png)

You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
</div>

This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
## Features
- **Deploy for free with one-click** on Vercel in under 1 minute
- Unlimited number of mailboxes, safe and reliable
- Adapted to the mobile terminal and PC terminal, the access is more convenient

## Learn More
## 主要功能
- 在 1 分钟内使用 Vercel **免费一键部署**
- 不限制邮箱数量,安全、可靠
- 适配了手机端、PC端,访问更便捷
- 拥有自己的域名?好上加好,绑定后即可在任何地方**无障碍**快速访问

To learn more about Next.js, take a look at the following resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
## Get Started
1. Click the button on the right to start deployment, [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/dapandocs/TempMail&project-name=temp-mail&repository-name=TempMail),Just log in directly with your Github account.
2. Once deployed, you can start using.

You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
## 开始使用

## Deploy on Vercel
1. 点击右侧按钮开始部署:
[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/dapandocs/TempMail&project-name=temp-mail&repository-name=TempMail),直接使用 Github 账号登录即可;
2. 部署完毕后,即可开始使用;
3. (可选)[绑定自定义域名](https://vercel.com/docs/concepts/projects/domains/add-a-domain):Vercel 分配的域名 DNS 在某些区域被污染了,绑定自定义域名即可直连。

The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
## Keep Updated
If you follow the above steps to deploy your own project with one click, you may find that you always prompt "There is an update", this is because Vercel will create a new project for you by default instead of forking this project, which will prevent you from detecting updates correctly.
It is recommended that you follow these steps to redeploy:


- Delete the original warehouse;
- Use the fork button in the upper right corner of the page to fork this project;
- Re-select and deploy in Vercel


## 保持更新

如果你按照上述步骤一键部署了自己的项目,可能会发现总是提示“存在更新”的问题,这是由于 Vercel 会默认为你创建一个新项目而不是 fork 本项目,这会导致无法正确地检测更新。
推荐你按照下列步骤重新部署:

- 删除掉原先的仓库;
- 使用页面右上角的 fork 按钮,fork 本项目;
- 在 Vercel 重新选择并部署

Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
Binary file added docs/images/mobile.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/pc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 7fef163

@vercel
Copy link

@vercel vercel bot commented on 7fef163 Jun 27, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.