diff --git a/README.md b/README.md index 4c0816e..dfc7335 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,9 @@ ο»Ώ[![V-Bed by INN STUDIO](https://wx3.sinaimg.cn/large/686ee05dly1fkvkxkwyhzj21gu0d2my8.jpg)](https://wx3.sinaimg.cn/large/686ee05dly1fkvkxkwyhzj21gu0d2my8.jpg) # 😎 X Prober -> This is a prober program for PHP environment. It can show your server information and readable easily. And the most important thing is that it's like ***iPhone X***! +> This is a prober program for **PHP environment**. It can show your server information and readable easily. + +And the most important thing is that it's like πŸ“± **iPhone X** and **πŸ“± iPhone XS Max**! ## License * GPL-v2 @@ -10,29 +12,32 @@ - [https://prober.inn-studio.com](https://prober.inn-studio.com) - [https://tz.inn-studio.com](https://tz.inn-studio.com) (same) -## Download -- [https://api.inn-studio.com/download?id=xprober](https://api.inn-studio.com/download?id=xprober) +## Download and Usage +- Click [https://api.inn-studio.com/download?id=xprober](https://api.inn-studio.com/download?id=xprober) to download. +- You will get a single file of `x.php` and upload it to your server. +- Access `x.php` via http browser. ## Required environment -- Compile environment: PHP 7.1+ +- Compile environment: PHP 7.2+ - Production environment: PHP 5.3+ - Browser support: IE9/Chrome/Firefox/Edge +- OS support: Linux / Windows(basic) -## Compile and Usage -- Star and clone. -- Check the config ./src/Config/Api.php -- Compile development: `$ php ./compile.php dev` -- Compile production: `$ php ./compile.php` -- Access ./dist/prober.php -- Enjoy +## For development +- Star⭐ and **Fork**. +- Compile **development**: `$ php ./make.php dev`. +- Compile **production**: `$ php ./make.php`. +- Access `./dist/prober.php` from http browser. +- Enjoy it. πŸ˜„ -## Help and translate to more language -- Fork and clone -- Config language ./src/I18n/Lang.json -- Pull request -- Thank you +## Help and translate more languages +- **Fork** project. +- Use [Poedit](https://poedit.net/) to create your language from `./lanuages/language.pot` language template file and trsanslate it. +- Save your language file *(like: `en_US.po`)* into `./languages`. +- Add your name and URL to contributors list. +- Pull Request and thank you. 😘 -## Participate in contribution +## Note for participate in contribution - Code compatible with IE9+ and PHP 5.3+ ## Contributors @@ -41,12 +46,9 @@ - More... ## TODO -- Temperature sensor -- More languages with Poedit -- Detail benchmark result - -## Note -- Only tested in Linux environment. +- [] Temperature sensor. +- [x] More languages with Poedit. +- [] Detail benchmark result. ## Keywords X-Prober/PHP ζŽ’ι’ˆ/X ζŽ’ι’ˆ/εˆ˜ζ΅·ζŽ’ι’ˆ