Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jason5ng32 committed May 15, 2024
1 parent 9edf622 commit db46b95
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 42 deletions.
16 changes: 2 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ Notes: You can use my demo for free, and you can also deploy it yourself.

## 📕 How to Use

There are 2 Ways to deploy:

### Deploying in a Node Environment

Make sure you have Node.js installed.
Expand All @@ -61,16 +59,10 @@ Clone the code:
git clone https://github.com/jason5ng32/MyIP.git
```

Install:

```bash
npm install
```

Build:
Install and build:

```bash
npm run build
npm install && npm run build
```

Run:
Expand Down Expand Up @@ -108,10 +100,6 @@ You can use the program without adding any environment variables, but if you wan
| `KEYCDN_USER_AGENT` | No | `""` | The domain name when using KeyCDN, must contain https prefix. Used to obtain IP address information through KeyCDN |
| `CLOUDFLARE_API` | No | `""` | API Key for Cloudflare, used to obtain AS system information through Cloudflare |

> [!TIP]
> Environment variables starting with `SECURITY_` are only valid when deploying using npm or Docker.
>
### Using Environment Variables in a Node Environment

Create environment variables:
Expand Down
16 changes: 2 additions & 14 deletions README_FR.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,8 +49,6 @@ Notes: Vous pouvez utiliser ma démo gratuitement et vous pouvez également la d

## 📕 Comment utiliser

Il existe 3 façons de déployer :

### Déploiement dans un environnement Node

Assurez-vous d'avoir Node.js installé.
Expand All @@ -61,16 +59,10 @@ Clonez le code :
git clone https://github.com/jason5ng32/MyIP.git
```

Installer:

```bash
npm install
```

Construire:
Installer & Construire :

```bash
npm run build
npm install && npm run build
```

Exécuter:
Expand Down Expand Up @@ -108,10 +100,6 @@ Vous pouvez utiliser le programme sans ajouter de variables d'environnement, mai
| `KEYCDN_USER_AGENT` | Non | `""` | Le nom de domaine lorsque vous utilisez KeyCDN, doit contenir le préfixe https. Utilisé pour obtenir des informations sur l'adresse IP via KeyCDN |
| `CLOUDFLARE_API` | Non | `""` | Clé API pour Cloudflare, utilisée pour obtenir des informations sur le système AS via Cloudflare |

> [!TIP]
> Les variables d'environnement commençant par `SECURITY_` ne sont valides que lors du déploiement à l'aide de npm ou de Docker.
>
### Utilisation des variables d'environnement dans un environnement Node

Créez les variables d'environnement :
Expand Down
16 changes: 2 additions & 14 deletions README_ZH.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,6 @@

## 📕 如何使用

2 种部署方式:

### 在 Node 环境部署

确保你系统里已经有 Node.js 环境。
Expand All @@ -63,16 +61,10 @@
git clone https://github.com/jason5ng32/MyIP.git
```

安装:

```bash
npm install
```

构建:
安装与编译:

```bash
npm run build
npm install && npm run build
```

运行:
Expand Down Expand Up @@ -110,10 +102,6 @@ docker run -d -p 18966:18966 --name myip --restart always jason5ng32/myip:latest
| `KEYCDN_USER_AGENT` || `""` | 使用 KeyCDN 时的域名,需包含 https 前缀。用于通过 KeyCDN 获取 IP 归属地信息 |
| `CLOUDFLARE_API` || `""` | Cloudflare 的 API Key,用于通过 Cloudflare 获取 AS 系统的信息 |

> [!TIP]
> `SECURITY_` 开头的环境变量仅在使用 npm 或 Docker 部署时有效。
>
### 在 Node 环境里使用环境变量

创建环境变量:
Expand Down

0 comments on commit db46b95

Please sign in to comment.