Browse Source

Update README.md

Corrected grammar, added information for bug reporting, modified project description to be more direct, moved fork information under license section, updated donation/support section.
Kristan Kenney 7 years ago
parent
commit
43cdf7f750
1 changed files with 16 additions and 11 deletions
  1. 16 11
      README.md

+ 16 - 11
README.md

@@ -8,27 +8,25 @@ Disclaimer
 
 What is Hestia Control Panel?
 ----------------------------
-* HestiaCP is a fork of VestaCP.
-* Main purpose of HestiaCP is to be more secure, better optimized and up to date.
 * An open source web server control panel with an easy-to-use interface.
 * A lightweight alternative to cPanel, Plesk, etc.
 
-What Hestia Control Panel supports?
+What features does Hestia Control Panel support?
 ----------------------------
 * Web Server (Apache/Nginx) with PHP
 * DNS Server (Bind)
-* Mail Server (Exim/Dovecot) with Antivirus and Spam Filter (ClamAV and SpamAssassin)
+* Mail Server (Exim/Dovecot) with Anti-Virus and Spam Filtering (ClamAV and SpamAssassin)
 * Database Server (MariaDB/PostgreSQL)
 
 System Requirements:
 ----------------------------
 * Debian 8 or 9
 * Ubuntu 16.04 LTS or Ubuntu 18.04 LTS
-* **NOTE:** Hestia Control Panel must be installed on a "clean" Operating System to ensure proper functionality.
+* **NOTE:** Hestia Control Panel must be installed on a "clean" operating system to ensure proper functionality.
 
 How to install:
 ----------------------------
-Connect to your server as root via SSH
+Log in to your server as root, either directly or via SSH:
 ```bash
 ssh [email protected]
 ```
@@ -36,11 +34,11 @@ Download the installation script:
 ```bash
 wget https://raw.githubusercontent.com/hestiacp/hestiacp/master/install/hst-install.sh
 ```
-Then run it:
+Run the installation script and follow the on-screen instructions:
 ```bash
 bash hst-install.sh
 ```
-To perform an unattended installation with the default options:
+To perform an unattended installation using the default options:
 ```bash
 bash hst-install-ubuntu.sh -f -y no -e <email> -p <password> -s <hostname>
 ```
@@ -48,13 +46,20 @@ For additional installation options:
 ```bash
 bash hst-install.sh -h
 ```
+Reporting bugs & issues:
+----------------------------
+If you've run into an issue with Hestia Control Panel, please let us know as soon as possible so that we may investigate further and resolve any issues in a timely manner.
+
+Bug reports can be filed using GitHub's [Issues](https://github.com/hestiacp/hestiacp/issues) feature located at the top of our repository.
 
 License:
 ----------------------------
-Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/master/LICENSE) license.
+Hestia Control Panel is licensed under [GPL v3](https://github.com/hestiacp/hestiacp/blob/master/LICENSE) license, and is based on VestaCP.<br>
 
-Donations:
+How to support Hestia Control Panel:
 ----------------------------
-Hestia Control Panel is open source and completely free for everyone!<br>If you like to make a donation in order to help cover development and infrastructure costs, you may do so via PayPal:
+Hestia Control Panel is open source and completely free for everyone to use.
+
+If you would like to help our developers cover their time and infrastucture costs, or to support the Hestia Control Panel project as a whole, please consider making a donation via PayPal.
 
 [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=ST87LQH2CHGLA)