From f1316530cc074f8c2b12fffdbbcdbca7e033189a Mon Sep 17 00:00:00 2001 From: Sean Madsen Date: Wed, 6 Sep 2017 13:36:39 -0600 Subject: [PATCH] README.md - Fix markdown formatting --- README.md | 44 +++++++++++++++++++++++++++----------------- 1 file changed, 27 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 12c4246e..54c510fb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -##CiviBooking +# CiviBooking + +## What is CiviBooking? -###What is CiviBooking? Are you a non-profit with Rooms or Resources that you think you could raise money by renting out? Or are you a community center or voluntary service looking to manage your resources better? Sick of spreadsheets, emails and that Google calendar that no one keeps up to date? Then CiviBooking is for you! CiviBooking is a CiviCRM extension which allows you to: @@ -15,7 +16,8 @@ CiviBooking is a CiviCRM extension which allows you to: Oh and of course everything integrates super nicely with search, contact tabs, CiviContribute for payments and some other tricks and tweaks along the way. -###Installing CiviBooking +## Installing CiviBooking + CiviBooking is a free and open source extension for CiviCRM that can be downloaded from the extensions directory. To find out more about the extensions directory and how to configure it please see below: @@ -24,16 +26,17 @@ To find out more about the extensions directory and how to configure it please s 2. Create and set your extensions directory in CiviCRM at: - http://example.com/civicrm/admin/setting/path?reset=1 + `http://example.com/civicrm/admin/setting/path?reset=1` - (You may need to create a folder for your extensions and set the permissions for that folder. See [Here](https://wiki.civicrm.org/confluence/display/CRMDOC43/Extensions) for full instructions and information on how to set and configure extensions.) + (You may need to create a folder for your extensions and set the permissions for that folder. See [Here](https://wiki.civicrm.org/confluence/display/CRMDOC43/Extensions) for full instructions and information on how to set and configure extensions.) 3. Once configured, simply got to the "add new" tab in your extensions listing: -http://example.com/civicrm/admin/extensions?reset=1 +`http://example.com/civicrm/admin/extensions?reset=1` + + Then locate the CiviBooking extension and click Download. - Then locate the CiviBooking extension and click Download. +## Overview -###Overview Like with all systems, before you configure CiviBooking you will need to do some planning. CiviBooking has support for “limited” and “unlimited” resources. @@ -53,9 +56,10 @@ Configuration option price x Quantity So if someone books for 2 days, you can simply set the price when booking to be 2 x Full day price. -###Configuration +## Configuration + +### Step 1: Define your configuration sets and options -####Step 1: Define your configuration sets and options For each resource you will need to decide on your configuration options. We suggest you start at this step, as without it you will not be able to add resources. Each configuration option also has a unit. You could choose to make the units whatever you wish, so if you wish to charge by hour, day, person or any other label, the system will allow you to do so. @@ -64,7 +68,8 @@ Start by creating your list of configuration size units. (For example this may b Then create a configuration set for Rooms. A configuration set can be used by more then 1 resource. After creating your set, add each pricing option. -####Step 2: Create your resources +### Step 2: Create your resources + **Resource types:** Resources can have different types. This defines the group that they will be shown in on the screen. You may wish to group resources by room, or by location depending on what is easiest. @@ -77,25 +82,30 @@ Now you are able to add your resources. For each resource you can select a type You can set the resource to be limited or unlimited here. -####Step 3: Cancellation charges +### Step 3: Cancellation charges + When cancelling a booking, a wizard page appears allowing you to set a cancellation charge based on the cost of the booking. This could be based on a percentage of the total cost of the booking and then a manual adjustment could be made. The % charges for cancellation can be adjusted in the cancellation charges option menu. Enter a number value which corresponds to the % discount charge in the value field. -####Step 4: Additional (Ad-hoc) charges items +### Step 4: Additional (Ad-hoc) charges items + Other charges can be added to the booking through the additional charges items. This may be charges for consumables used during the booking that need to be added after the booking has completed. You can add items and a price for each item in the Additional Charges item menu link. -###Addon +## Addon + We have also created a Drupal view integration module for CiviBooking. This module creates view handlers for booking entities which enables the display of booking data on the Drupal side. It also has a few built-in calendar view templates which can be used to create calendar views for bookings and resource availability. https://github.com/compucorp/civiBooking_calendar -###Credit +## Credit + CiviBooking was developed by Compucorp Ltd with kind funding from the GMCVO, Blackburn with Darwin CVS and Zing Foundation -###Support +## Support + If you have issues with the CiviBooking extension please comment on the github issues list Here. Please provide your extension and environment detail in the ticket to help accelarate the investigations. CiviCRM Extension Page: https://civicrm.org/extensions/civibooking @@ -104,8 +114,8 @@ Please contact the follow email if you have any question: Paid support for this extension is available, please contact us either via github or at info@compucorp.co.uk -
[![Compucorp Ltd.][1]][2] + [1]: https://www.compucorp.co.uk/sites/default/files/logo.png [2]: https://www.compucorp.co.uk