Update README

faheemzunjani · Oct 29, 2018 · e17209a · e17209a
1 parent c948d7f
commit e17209a
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 5 deletions.
diff --git a/.DS_Store b/.DS_Store
diff --git a/README.md b/README.md
@@ -1,6 +1,28 @@
-# PoolPal
-Prototype 2018
+# PoolPal   &middot;   ![](https://img.shields.io/github/license/mashape/apistatus.svg) ![](https://img.shields.io/npm/v/npm.svg)
+## Community-driven purchase and delivery, and carpool app created during Headout presents Prototype 2018 hackathon
 
-Pool Pal is a community app meant to help college and university students in particular. 
-It allows students to place requests for things they might need and displays these notifications to the people going into town already. It manages payments and allows cab pooling as well.
-The front end is scripted in react while the backend is node js(express).
+### About
+PoolPal is a community-driven app meant to help college and university students in particular.   
+
+It allows students to place requests for things they might need and displays these notifications to the people going into town. Users can request for things from any store and other users in the vicinity of that store can accept their requests and deliver it to them when they return to the university.  
+
+Features complete end-to-end transaction between the acceptor and the requester with OTP based verification of delivery.
+
+### User Interface
+#### As requester
+<img src="./GIFs/requester.gif" width=35% height=35%/>
+
+#### As request acceptor
+<img src="./GIFs/acceptor.gif" width=35% height=35%/>
+
+#### As cabpool requester
+<img src="./GIFs/cabpool.gif" width=35% height=35%/>
+
+### Under the hood
+Built using [React](https://reactjs.org/) for front-end, [Node.js(Express)](https://expressjs.com/) for back-end and [Google Maps API](https://developers.google.com/maps/documentation/javascript/tutorial) for location-based features.
+
+### Creators
+[Faheem Hassan Zunjani](https://github.com/faheemzunjani)  
+[Gaganjeet Reen](https://github.com/piano-man)  
+[Ankur Dengla](https://github.com/ankurdengla1996)  
+[Arpit Bahety](https://github.com/ArpitRF/)