From 99ad0710a679097105f876365b45b9051bd6dd84 Mon Sep 17 00:00:00 2001
From: Martin Donnelly <martind2000@gmail.com>
Date: Tue, 3 Nov 2020 23:16:51 +0000
Subject: [PATCH] Added some documentation

---
 README.md | 87 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 87 insertions(+)

diff --git a/README.md b/README.md
index e69de29..4743e28 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,87 @@
+# Carpark
+
+A Parking Charge Calculator
+
+### Features
+
+* Calculates Short term parking!
+
+* Calculates Long term parking!
+
+
+### To run
+
+To install run the following in the folder
+
+```
+
+    cd carpark
+    npm install
+
+```
+
+To run the tests
+
+```
+
+    # For Javascript
+    npm run test:js
+
+    # For Typescript
+    npm run test:ts
+
+```
+
+### Usage
+
+```javascript
+
+
+  const Carpark = require('../lib/carpark');
+
+  const carPark = new Carpark();
+
+  const start = '07/09/2017 16:50:00';
+  const end = '09/09/2017 19:15:00';
+
+  // calculate(start, end, mode)
+  
+  // Mode can be 'short', 'shortterm' / 'long', 'longterm'
+
+  console.log(carPark.calculate(start, end, 'short'));
+
+```
+
+
+
+### Current Test Results
+
+##### Javascript
+
+```
+Carpark Calculator
+    ✓ Should return 0.00 outside of a chargeable period
+    ✓ A specific short stay should cost £12.28
+    ✓ A specific long stay should cost £22.50
+    ✓ A very specific long stay should cost £15.00
+    ✓ A single day of long stay should cost £7.50
+    ✓ A single week of long stay should cost £52.50
+
+
+  6 passing (8ms)
+```
+
+##### Typescript
+
+```
+Carpark Calculator
+    ✓ Should return 0.00 outside of a chargeable period
+    ✓ A specific short stay should cost £12.28
+    ✓ A specific long stay should cost £22.50
+    ✓ A very specific long stay should cost £15.00
+    ✓ A single day of long stay should cost £7.50
+    ✓ A single week of long stay should cost £52.50
+
+
+  6 passing (6ms)
+```