Update README.md

Author: Pruthvi Kumar

README.md

@@ -1,33 +1,30 @@
 # FITBIT WEB SERVICE USING PYTHON
 
-FITBIT Api's are authenticated by oAuth2.0. In here, there is a Python Web Service coded as a wrapper around Fitbit's conventional API's using Python's Falcon Web Services Framework. 
+Python wrapper; a RESTful wrapper over FITBIT.
 
-NOTE: THIS CODEBASE USES FALCON & GUNICORN TO  FACILITATE WEB SERVICE. GUNICORN WORKS ONLY ON UNIX/LINUX MACHINES. HENCE, THIS WILL BE OPERATIONAL ONLY ON LINUX DISTRO'S /UNIX MACHINES. WINDOWS IMPLEMENTATION IS WIP.
+NOTE: uses gunicorn (https://docs.gunicorn.org/en/stable/index.html) which is WSGI HTTP server for `*nix` systems. On windows, you might want to swap gunicorn with uWSGI or other alternatives.
 
 # Features:
-  - oAuth Authorization callable via dedicated endpoint.
-  - Fitbit config will be easy and manageable.
-  - Multithreaded usage using gunicorn server to build seamless apps using Fitbit data.
-
-# Setup:
-- Create a valid fitbit account and setup an App here - https://dev.fitbit.com/apps/new
-- Make notes of client ID and client secret.
-- clone this repo; ensure to cd into the directory 'fitbit_webservice'.
-- cd fitbit_webservice/config -> edit file named 'fitbit_wrapper_config.py', add client ID and client secret where its asked to; save.
-- pip install all the requirements (Python=3). (NOTE: Always better to create a dedicated virtual environment. Either using Anaconda /Conventional Python)
-- To start the web service, type the following command (whilst staying on 'fitbit_webservice' directory):
+  - oAuth via dedicated endpoint.
+  - config is simpler.
+  - leverages concurrency & threading - so its decently fast.
+
+# Getting Started:
+- Create a valid fitbit account and setup an `App` here - https://dev.fitbit.com/apps/new
+- Grab your `client ID` and `client secret`.
+- Clone &  `cd fitbit_webservice`
+- Edit `fitbit_wrapper_config.py` > add client ID and client secret > save.
+- `pip install -r requirements.txt` in venv of your choice.
 ```sh
     gunicorn -b localhost:8000 fitbit_web_service:app --reload
 ```
-- The above command must start gunicorn server locally and listen on port 8000 (Please feel free to change this to your convinience).
-- Go to webserver and check with this endpoint:
+- Interact with your webservice with dedicated #Keywords:
 ```sh
     http://localhost:8000/processFitbitApi?keyword=todays_steps_real_time
 ```
-- When the above request is served for the first time, oAuth will carry on with its magic to create valid token's for usage. Response from these requests will be self-explanatory.
 
 # Keywords
-- todays_steps_realtime: Get Real time steps (Until last sync with Fitbit) from fitbit.
+- todays_steps_realtime: Get Real time steps (Until last sync with the device) from fitbit.
 - last_7_days_steps: Get total steps covered for last 7 days.
 - todays_calories_realtime: Get calories burned for for current day.
 - last_7_days_calories: Get calories burned data for last 7 days.
@@ -46,9 +43,6 @@ NOTE: THIS CODEBASE USES FALCON & GUNICORN TO  FACILITATE WEB SERVICE. GUNICORN
 - todays_sleep_details: Get sleep details for current day.
 - todays_heart_details: Get heart details for current day.
 
-# Support
-For any issues write to Pruthvi @ pruthvikumar.123@gmail.com. Ensure to have a valid subject line, detailed message with appropriate stack trace to expect prompt/quick response. 
-
 # License
 ----
 MIT License