update docs

.gitignore

@@ -1,5 +1,5 @@
 # Ignoring shape predictor
-app/data/classifiers/shape_predictor_68_face_landmarks.dat
+app/data/classifiers/*.dat
 
 # Byte-compiled / optimized / DLL files
 __pycache__/

README.md

@@ -0,0 +1,64 @@
+<p align="center">
+    <img style="display:block;text-align:center" src="./docs/logos/cssi-logo-rest-api.svg" alt="logo-text" width="600" />
+    <p align="center" style="font-size: 1.2rem;">RESTful API for the CSSI Platform</p>
+</p>
+
+<!-- Badges -->
+<p align="center">
+  <a href="https://app.fossa.io/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api?ref=badge_shield" alt="FOSSA Status"><img src="https://app.fossa.io/api/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api.svg?type=shield"/></a>
+  <a href="LICENSE.md">
+  <img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License: MIT" height="18">
+  </a>
+</p>
+
+# Getting Started
+
+```bash
+# clone the repository
+git clone https://github.com/project-cssi/cssi-api.git
+
+# change the directory
+cd cssi-api
+
+# install the dependencies
+pip install -r requirements.txt
+
+# create the database
+python manage.py recreate_db
+
+# add metadata to database
+python manage.py create_metadata
+
+# fire up redis server
+redis-server
+
+# start celery workers
+python manage.py celery
+
+# run the app
+python manage.py runserver
+
+```
+
+# Built With
+
+<a href="https://www.python.org/" title="Python"><img src="./docs/technologies/python.svg" alt="python" height="30" /></a>&nbsp;&nbsp;
+<a href="http://flask.pocoo.org/" title="Flask"><img src="./docs/technologies/flask.svg" alt="flask" height="30" /></a>&nbsp;&nbsp;
+<a href="https://flask-socketio.readthedocs.io/en/latest/" title="Flask SocketIO"><img src="./docs/technologies/flask-socketio.png" alt="redux" height="30" /></a>&nbsp;&nbsp;
+<a href="https://flask-sqlalchemy.palletsprojects.com/en/2.x/" title="Flask SQL Alchemy"><img src="./docs/technologies/flask-sqlalchemy.png" alt="lodash" height="30" /></a>&nbsp;&nbsp;
+<a href="http://www.celeryproject.org/" title="Celery"><img src="./docs/technologies/celery.png" alt="celery" height="50" /></a>&nbsp;&nbsp;
+<a href="https://marshmallow.readthedocs.io/en/3.0/" title="Marshmallow"><img src="./docs/technologies/marshmallow.png" alt="marshmallow" height="50" /></a>&nbsp;&nbsp;
+<a href="https://www.mysql.com/" title="MySQL"><img src="./docs/technologies/mysql.svg" alt="sass" height="50" /></a>&nbsp;&nbsp;
+<a href="https://redis.io/" title="Redis"><img  src="./docs/technologies/redis.png" alt="redis" height="30" /></a>&nbsp;&nbsp;
+
+# Changelog
+
+Please refer [CHANGELOG.md](CHANGELOG.md) to learn about the latest improvements, breaking changes and bug fixes.
+
+# Contributing
+
+Please read [CONTRIBUTING.md](CONTRIBUTING.md) for contributing guidelines and to learn about our code of conduct.
+
+# License
+
+[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fproject-cssi%2Fcssi-api?ref=badge_large)

app/data/classifiers/readme.txt

@@ -1,2 +1,2 @@
 use the bellow link to download the shape predictor file.
-http://dlib.net/files/shape_predictor_68_face_landmarks.dat.bz2
+https://github.com/brionmario/dlib-custom-facial-landmark-model/blob/master/hmd_face_landmarks.dat