From 9c7601308c53b307d5a8d8eb148a37df788e24f0 Mon Sep 17 00:00:00 2001
From: Ranchi-Mall <32006557+Ranchi-Mall@users.noreply.github.com>
Date: Sun, 17 Sep 2017 20:40:55 +0530
Subject: [PATCH] README.md

An Order Matching Algorithm project based on David Veksler "Bitcoin Exchange Project".
---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b75830e
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# flo-exchange
+
+This is an order matching algorithm website code inspired by "Bitcoin Exchange Project" 
+by David Veksler (http://automagical.rationalmind.net/2013/10/16/bitcoin-order-matching-algorithm/).
+
+The algorithm, however, may not exactly work same as David's as it was modified a little to meet Ranchi Mall's 
+Florincoin Exchange project.
+
+The script contains basic functionalities of buying, selling and market order of, in fact, any article that can be traded online 
+(Florincoin tokens in our case). The system also contains a basic Facebook authentication system to store users basic information. 
+It is currently a singe page website with basic display of users, transactions and other important features that an exchange site 
+is expected to have.
+
+
+
+