From f5ac3f75a315784866fa1eb2cfed4fac336f0e31 Mon Sep 17 00:00:00 2001
From: Helen Chong <119173961+helenclx@users.noreply.github.com>
Date: Thu, 27 Jun 2024 21:36:50 +0800
Subject: [PATCH] Expand Read Me with info about new features and instructions

---
 README.md | 31 +++++++++++++++++++++++++------
 1 file changed, 25 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 400a712..4790752 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,31 @@
-# BellaBuffs with PHPMailer Support
+# BellaBuffs with PHPMailer Integration
 
-This is a fork of the fanlisting PHP script [BullaBuffs](https://github.com/jemjabella/BellaBuffs), with [PHPMailer](https://github.com/PHPMailer/PHPMailer) powering the email sending features.
+This is a fork of the fanlisting PHP script [BullaBuffs](https://github.com/jemjabella/BellaBuffs), with [PHPMailer](https://github.com/PHPMailer/PHPMailer) powering the email sending functions.
 
-This fork replaces the PHP `mail()` functions from BellaBuffs with PHPMailer, allowing a fanlisting to send out emails, provided the fanlisting owner chooses to enable them, even if the hosting server does not support the PHP `mail()` function.
+## Desciption
+
+BellaBuffs includes the optional features to email new members after submitting the join form, email the fanlisting admin when a new member joins or email new members when their applications were approved. The original BellaBuffs script achieved this by using PHP's built-in `mail()` feature.
+
+This fork replaces the PHP `mail()` functions from BellaBuffs with PHPMailer, allowing a fanlisting to send out emails with SMTP, provided the fanlisting owner chooses to enable them, even if the hosting server does not support the PHP `mail()` function.
 
 The PHPMailer script that is incorporated in this fork is based on [InfinityFree](https://www.infinityfree.com/)'s [PHPMailer contact form script](https://github.com/InfinityFreeHosting/contactform). As InfinityFree's free hosting plan [does not support PHP `mail()` function](https://forum.infinityfree.com/t/sending-email-from-your-website-php-mail/49242), InfinityFree has provided their contact form script as an alternative.
 
-This BellaBuffs fork is tested with PHP 8.2 on InfinityFree's free hosting.
+This BellaBuffs fork has been tested with PHP 8.2 on InfinityFree's free hosting.
+
+## New Features
+* Integrate PHPMailer for the email sending features, should the fanlisting owner enables these features
+* Email sending features are enabled by default, but can be disabled in `prefs.php`
+* Add HTML `required` attribute to required form fields
+* Add a buttons folder (with a placeholder file to enable the folder to be pushed via Git), so users do not need to manually create the folder to store uploaded buttons
+
+## Usage Instructions
+1. Customise your preferences in `prefs.php`
+1. Configure your email SMTP settings in `contactform/config.php`
+1. Upload all files of this fork to a directory where you want your fanlisting to be located
+1. Set file permissions of all the `.txt` files to CHMOD 666 to make the text files writeable
+1. Set permission of the `buttons` directory to CHMOD 777 to enable buttons to be uploaded to the directory (NOTE: It is recommended to set the permissions of `buttons` directory to CHMOD 755 when not using the button upload features for better security)
+
+More instructions for using BellaBuffs can be found in the [original Read Me of BellaBuffs](https://github.com/helenclx/BellaBuffs-PHPMailer/blob/master/README-original.txt).
 
 ## Permissions
 
@@ -15,6 +34,6 @@ You are free to use this BellaBuffs fork and customise it as much as you like. Y
 However, regardless if you choose to credit me for this fork or not, per the original author Jem Turner's Read Me, you must link back to Jem Turner at https://www.jemjabella.co.uk/. By using BellaBuffs, you also agree not to sell copies of the script, or services relating to the script (i.e. installation, customisation, etc) without written permission of Jem Turner. You can read [Jem Turner's original Read Me file here](https://github.com/helenclx/BellaBuffs-PHPMailer/blob/master/README-original.txt).
 
 ## Credits
-* [Jem Turner](https://www.jemjabella.co.uk/) - The original author of [BellaBuffs](https://www.jemjabella.co.uk/scripts/bellabuffs/).
-* [InfinityFree](https://www.infinityfree.com/) for their [PHPMailer contact form script](https://github.com/PHPMailer/PHPMailer).
+* [Jem Turner](https://www.jemjabella.co.uk/) - The original author of [BellaBuffs](https://www.jemjabella.co.uk/scripts/bellabuffs/)
+* [InfinityFree](https://www.infinityfree.com/) for their [PHPMailer contact form script](https://github.com/PHPMailer/PHPMailer)
 * [PHPMailer](https://github.com/PHPMailer/PHPMailer)
\ No newline at end of file