Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jason5ng32 committed Dec 13, 2023
1 parent 15c3f59 commit 7d79659
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 4 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Notes: You can use my demo, but please don't use it for commercial purposes. If

## 📕 How to Use

3 Ways to Deploy:
There are 3 Ways to Deploy:

### Deploying in a Node Environment

Expand Down Expand Up @@ -77,9 +77,17 @@ BING_MAP_API_KEY
ALLOWED_DOMAINS
```

Or, click this button to deploy with environment variables:

[![Deploy with Vercel](https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/res/img/Vercel.svg)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fjason5ng32%2FMyIP&env=BING_MAP_API_KEY,ALLOWED_DOMAINS)

### Using Docker

Click the 'Deploy to Docker' button at the top to complete the deployment.
Click the 'Deploy to Docker' button at the top to complete the deployment. Or, use the following shell:

```bash
docker run -d -p 8966:8966 --name myip --restart always jason5ng32/myip:latest
```

If you wish to display maps, set the Bing Map API Key and allowed domains during deployment:

Expand Down
12 changes: 10 additions & 2 deletions README_CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,24 @@ ALLOWED_DOMAINS="example.com"

点击顶部的部署到 Vercel 按钮,即可完成部署。

如果希望展示地图,则在部署的时候,设置下面 2 个环境变量:
如果希望展示地图,则在部署的时候,添加下面 2 个环境变量:

```bash
BING_MAP_API_KEY
ALLOWED_DOMAINS
```

或者,直接点击下面这个包含了环境变量的安装按钮:

[![Deploy with Vercel](https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/res/img/Vercel.svg)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fjason5ng32%2FMyIP&env=BING_MAP_API_KEY,ALLOWED_DOMAINS)

### 使用 Docker

点击顶部的部署到 Docker 按钮,即可完成部署。
点击顶部的部署到 Docker 按钮,即可完成部署,又或者,直接输入下面的命令:

```bash
docker run -d -p 8966:8966 --name myip --restart always jason5ng32/myip:latest
```

如果你希望展示地图,则在部署的时候,设置 Bing Map API Key 和允许的域名:

Expand Down

0 comments on commit 7d79659

Please sign in to comment.