Skip to content

Commit e7a827e

Browse files
committed
Update readme + refactor + branding + more installation informations
1 parent 6e80ba4 commit e7a827e

File tree

1 file changed

+42
-17
lines changed

1 file changed

+42
-17
lines changed

README.md

Lines changed: 42 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,66 @@
1-
phpwpinfo
2-
=========
1+
<a href="https://beapi.fr">![Be API Github Banner](.wordpress.org/banner-github.png)</a>
32

4-
phpwpinfo provides an equivalent to the phpinfo() function that reports WordPress Requirements information about the PHP/MySQL/Apache environment, and offers suggestions for improvement.
3+
# phpwpinfo
54

6-
This tool allows you to quickly test environment server where you want to install WordPress.
7-
The default credentials for display the result are :
5+
phpwpinfo provides an equivalent to the `phpinfo()` function but with more WordPress requirements details about the PHP/MySQL/Apache environment and also offers suggestions for improvement.
6+
This tool allows you to quickly test environment server where you want to install WordPress. It is written in full PHP and use Bootstrap for HTML/CSS/JS purpose, provided by [CDN](http://www.bootstrapcdn.com).
87

8+
# How ?
9+
10+
## Installation
11+
12+
Talking about the main file ([phpwpinfo.php](https://github.com/BeAPI/phpwpinfo/blob/master/phpwpinfo.php)), copy it's content, download the [raw](https://raw.githubusercontent.com/BeAPI/phpwpinfo/master/phpwpinfo.php) file or even better "wget" it directly on your server :
13+
`wget https://raw.githubusercontent.com/BeAPI/phpwpinfo/master/phpwpinfo.php`
14+
15+
## Usage
16+
17+
Then simply reach the my-site.com/phpwpinfo.php url on your site to get the results, which are protected with the following credentials :
918
* Login : wordpress
1019
* Password : wordpress
1120

12-
This script can, if your server allow it, delete itself.
21+
# What ?
22+
23+
## 1. Self deletion
24+
25+
This tool can, if your server allow it, delete itself.
26+
27+
## 2. What it checks for
1328

1429
It tests various elements such as :
15-
1630
* PHP & MySQL Version
1731
* Apache modules
1832
* PHP Extensions
1933
* PHP Configuration
2034
* MySQL Configuration
2135
* Mail server feature
2236

23-
It also allows you to quickly view phpinfo () and MySQL variables.
37+
## 3. Display phpinfo and more
2438

25-
Finally, it allows (if you server allows it) to quickly install :
39+
It also allows you to quickly view `phpinfo()` and MySQL variables.
2640

41+
## 4. Quick install
42+
43+
Finally, it allows (if you server allows it) to quickly install :
2744
* [Adminer](http://www.adminer.org/en/)
2845
* [PHPsecinfo](http://phpsec.org/projects/phpsecinfo/)
2946
* [Latest version of WordPress (US)](http://wordpress.org/)
3047

31-
This script is writted in full PHP and use Bootstrap for HTML/CSS/JS provided by CDN (http://www.bootstrapcdn.com/)
48+
## Contributing
49+
50+
Please refer to the [contributing guidelines](.github/CONTRIBUTING.md) to increase the chance of your pull request to be merged and/or receive the best support for your issue.
51+
52+
### Issues & features request / proposal
53+
54+
If you identify any errors or have an idea for improving this tool, feel free to open an [issue](../../issues/new). Please provide as much info as needed in order to help us resolving / approve your request.
55+
56+
# Who ?
57+
58+
Created by [Be API](https://beapi.fr), the French WordPress leader agency since 2009. Based in Paris, we are more than 30 people and always [hiring](https://beapi.workable.com) some fun and talented guys. So we will be pleased to work with you.
59+
60+
This tool is only maintained, which means we do not guarantee some free support. Consider reporting an [issue](#issues--features-request--proposal) and be patient.
3261

33-
License: GPL v2
62+
If you really like what we do or want to thank us for our quick work, feel free to [donate](https://www.paypal.me/BeAPI) as much as you want / can, even 1€ is a great gift for buying cofee :)
3463

35-
### Changelog:
64+
## License
3665

37-
* Version 1.1
38-
* Implement recommended/required for each config/module
39-
* Improve test config value
40-
* Version 1.0
41-
* Initial release
66+
phpwpinfo is licensed under the [GPLv3 or later](LICENSE.md).

0 commit comments

Comments
 (0)