From 67f2576e632f83a169e1a72dd0feadab195d5f3c Mon Sep 17 00:00:00 2001
From: vmdiwanji <54455062+vmdiwanji@users.noreply.github.com>
Date: Tue, 3 Mar 2020 22:06:21 -0800
Subject: [PATCH] Revert "Update ReadMe file"

This reverts commit 98ceb39f8fbfa405e8ed5fc7ba1988a04d4f7259.
---
 README.md | 26 +++++++++++++-------------
 1 file changed, 13 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 09e8a542..b08f18b7 100644
--- a/README.md
+++ b/README.md
@@ -5,21 +5,24 @@ Installation Instructions -
 
 `pip3 install -r requirements.txt`
 
-Configuration:
-
 Create a config.json file using the sample file in the repository.
 
-Path to the corresponding Model files are provided as shown in the sample config file.
+Command Line Interface - 
 
-Optional Authentication:
+createJSON.py generates a JSON object after extracting useful information from the github repository. It classifies the readme file into one of four categories - description, invocation, installation, citation depending on highest confidence above a given threshold.
 
-Add the following line to the config.json to add Authentication for requests to github repository:
+The createJSON.py file takes as input the following parameters:
 
-`"Authentication": "token PersonalAccessToken"`
+-r / --repo_url: Link to the github repository for extracting information
 
-Information on generating Personal Access Token - https://help.github.com/en/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line
+-m / --model_path: Path to the pickled models for extraction
+
+-o / --output: Output file name
+
+-t / --threshold: Threshold to classify the content of the readme file
+
+-d / --doc_src: Path of documentation file
 
-Command Line Interface - 
 
 cli.py generates a JSON object after extracting useful information from the github repository. It classifies the readme file into one of four categories - description, invocation, installation, citation depending on confidence above a given threshold.
 
@@ -33,11 +36,8 @@ The cli.py file takes as input the following parameters:
 
 -d / --doc_src: Path of documentation file
 
-Add/Remove a Category:
-
-If user wants to run the classifier for an additional category or wants to remove an existing category, corresponding path entry in the config.json should be provided and the category type should be added in the category variable in the cli.py
-
-
 Example:
 
+`python3 createJSON.py -r https://github.com/{owner}/{repository_name} -m ./models/ -o output.json -t 0.5`
+
 `python3 cli.py -r https://github.com/{owner}/{repository_name} -o output.json -t 0.5`