Skip to content

Commit

Permalink
Merge pull request #184 from jason5ng32/dev
Browse files Browse the repository at this point in the history
Update README
  • Loading branch information
jason5ng32 authored Apr 17, 2024
2 parents 7f2fb4e + 75ae448 commit 39abf08
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 15 deletions.
14 changes: 9 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# 🧰 MyIP - A Better IP Toolbox

<img src="https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png">
![IPCheck.ing Banner](https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png)

![GitHub Repo stars](https://img.shields.io/github/stars/jason5ng32/MyIP)
![GitHub forks](https://img.shields.io/github/forks/jason5ng32/myip)
![Docker Pulls](https://img.shields.io/docker/pulls/jason5ng32/myip)
![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing)
![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![GitHub license](https://img.shields.io/github/license/jason5ng32/MyIP)

![CodeQL](https://github.com/jason5ng32/MyIP/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)
![Docker Build and Push](https://github.com/jason5ng32/MyIP/actions/workflows/docker-image.yml/badge.svg?branch=main)

![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![Windows-image](https://img.shields.io/badge/-Windows-blue?logo=windows)
![MacOS-image](https://img.shields.io/badge/-MacOS-black?logo=apple)
![Linux-image](https://img.shields.io/badge/-Linux-333?logo=ubuntu)

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing 'IPCheck.ing')](https://ipcheck.ing)

🇺🇸 [English](README.md) | 🇨🇳 [简体中文](README_ZH.md) | 🇫🇷 [Français](README_FR.md)

👉 Demo: [https://ipcheck.ing](https://ipcheck.ing)
Expand Down Expand Up @@ -118,7 +122,7 @@ Modify `.env`, and for example, add the following:
PORT=18966
BING_MAP_API_KEY="YOUR_KEY_HERE"
ALLOWED_DOMAINS="example.com"
IPChecking_API="YOUR_KEY_HERE"
IPCHECKING_API="YOUR_KEY_HERE"
```

Then restart the backend service.
Expand All @@ -135,7 +139,7 @@ You can add environment variables when running Docker, for example:
docker run -d -p 18966:18966 \
-e BING_MAP_API_KEY="YOUR_KEY_HERE" \
-e ALLOWED_DOMAINS="example.com" \
-e IPChecking_API="YOUR_TOKEN_HERE" \
-e IPCHECKING_API="YOUR_TOKEN_HERE" \
--name myip \
jason5ng32/myip:latest

Expand Down
14 changes: 9 additions & 5 deletions README_FR.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# 🧰 MyIP - Une meilleure boîte à outils IP

<img src="https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png">
![IPCheck.ing Banner](https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png)

![GitHub Repo stars](https://img.shields.io/github/stars/jason5ng32/MyIP)
![GitHub forks](https://img.shields.io/github/forks/jason5ng32/myip)
![Docker Pulls](https://img.shields.io/docker/pulls/jason5ng32/myip)
![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing)
![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![GitHub license](https://img.shields.io/github/license/jason5ng32/MyIP)

![CodeQL](https://github.com/jason5ng32/MyIP/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)
![Docker Build and Push](https://github.com/jason5ng32/MyIP/actions/workflows/docker-image.yml/badge.svg?branch=main)

![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![Windows-image](https://img.shields.io/badge/-Windows-blue?logo=windows)
![MacOS-image](https://img.shields.io/badge/-MacOS-black?logo=apple)
![Linux-image](https://img.shields.io/badge/-Linux-333?logo=ubuntu)

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing 'IPCheck.ing')](https://ipcheck.ing)

🇺🇸 [English](README.md) | 🇨🇳 [简体中文](README_ZH.md) | 🇫🇷 [Français](README_FR.md)

👉 Démo: [https://ipcheck.ing](https://ipcheck.ing)
Expand Down Expand Up @@ -118,7 +122,7 @@ Modifiez le fichier `.env`, et par exemple, ajoutez ce qui suit :
PORT=18966
BING_MAP_API_KEY="YOUR_KEY_HERE"
ALLOWED_DOMAINS="example.com"
IPChecking_API="YOUR_KEY_HERE"
IPCHECKING_API="YOUR_KEY_HERE"
```

Ensuite, redémarrez le service backend.
Expand All @@ -135,7 +139,7 @@ Vous pouvez ajouter des variables d'environnement lors de l'exécution de Docker
docker run -d -p 18966:18966 \
-e BING_MAP_API_KEY="YOUR_KEY_HERE" \
-e ALLOWED_DOMAINS="example.com" \
-e IPChecking_API="YOUR_TOKEN_HERE" \
-e IPCHECKING_API="YOUR_TOKEN_HERE" \
--name myip \
jason5ng32/myip:latest

Expand Down
14 changes: 9 additions & 5 deletions README_ZH.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@
# 🧰 IP 工具箱

<img src="https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png">
![IPCheck.ing Banner](https://raw.githubusercontent.com/jason5ng32/MyIP/main/public/gh_banner.png)

![GitHub Repo stars](https://img.shields.io/github/stars/jason5ng32/MyIP)
![GitHub forks](https://img.shields.io/github/forks/jason5ng32/myip)
![Docker Pulls](https://img.shields.io/docker/pulls/jason5ng32/myip)
![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing)
![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![GitHub license](https://img.shields.io/github/license/jason5ng32/MyIP)

![CodeQL](https://github.com/jason5ng32/MyIP/actions/workflows/github-code-scanning/codeql/badge.svg?branch=main)
![Docker Build and Push](https://github.com/jason5ng32/MyIP/actions/workflows/docker-image.yml/badge.svg?branch=main)

![PWA](https://img.shields.io/badge/PWA-Supported-blue)
![Windows-image](https://img.shields.io/badge/-Windows-blue?logo=windows)
![MacOS-image](https://img.shields.io/badge/-MacOS-black?logo=apple)
![Linux-image](https://img.shields.io/badge/-Linux-333?logo=ubuntu)

[![Website](https://img.shields.io/website?url=https%3A%2F%2Fipcheck.ing&up_message=online&label=IPCheck.ing 'IPCheck.ing')](https://ipcheck.ing)

🇺🇸 [English](README.md) | 🇨🇳 [简体中文](README_ZH.md) | 🇫🇷 [Français](README_FR.md)

👉 在这里体验:[https://ipcheck.ing](https://ipcheck.ing)
Expand Down Expand Up @@ -120,7 +124,7 @@ cp .env.example .env
PORT=18966
BING_MAP_API_KEY="YOUR_KEY_HERE"
ALLOWED_DOMAINS="example.com"
IPChecking_API="YOUR_KEY_HERE"
IPCHECKING_API="YOUR_KEY_HERE"
```

然后重新启动后端服务。
Expand All @@ -137,7 +141,7 @@ IPChecking_API="YOUR_KEY_HERE"
docker run -d -p 18966:18966 \
-e BING_MAP_API_KEY="YOUR_KEY_HERE" \
-e ALLOWED_DOMAINS="example.com" \
-e IPChecking_API="YOUR_TOKEN_HERE" \
-e IPCHECKING_API="YOUR_TOKEN_HERE" \
--name myip \
jason5ng32/myip:latest

Expand Down

0 comments on commit 39abf08

Please sign in to comment.