tidy up readme

This commit is contained in:
Nathan Coad
2018-06-17 10:30:02 +10:00
parent 638e0807ac
commit 9cf693585d

View File

@@ -1,7 +1,18 @@
Drupal 7 module for managing event bookings. Drupal 7 module for managing event bookings.
To install: ## Pre-installation
Before installation, download and install the following pre-requisite modules:
- [libraries](http://drupal.org/project/libraries) module
- [token](http://drupal.org/project/token) module
- [date](http://drupal.org/project/date) module
- [mimemail](http://drupal.org/project/mimemail) module
- [mailsystem](http://drupal.org/project/mailsystem) module
If you plan to use Stripe for payment integration, download the [Stripe API Library for PHP](https://stripe.com/docs/libraries) and install in your sites libraries folder (usually sites/all/libraries). The folder should be renamed to stripe (ie sites/all/libraries/stripe/lib/Stripe.php).
## Installation
- Clone (or download & unpack) this module into your site's module directory (usually sites/all/modules) - Clone (or download & unpack) this module into your site's module directory (usually sites/all/modules)
- If not installed, download the [libraries](http://drupal.org/project/libraries) module, the [token](http://drupal.org/project/token) module and the [date](http://drupal.org/project/date) module
- Download the [Stripe API Library for PHP](https://stripe.com/docs/libraries) and install in your sites libraries folder (usually sites/all/libraries). The folder should be renamed to stripe (ie sites/all/libraries/stripe/lib/Stripe.php).
- Enable the booking module, and visit the [configuration page](http://your.site.com/admin/config/booking/general) to set initial values and save prior to using module - Enable the booking module, and visit the [configuration page](http://your.site.com/admin/config/booking/general) to set initial values and save prior to using module
## Configuration
In addition to the main configuration page, you will need to set up [text definitions](http://your.site.com/admin/config/booking/text) for various built-in pages, as well as update [email definitions](http://your.site.com/admin/config/booking/emails) for automatically generated emails.