From d2f64c80d807d0bb48728a802cecf5f560d66517 Mon Sep 17 00:00:00 2001
From: Amaan Iqbal <amaaniqbal2786@gmail.com>
Date: Mon, 9 Mar 2020 23:57:51 +0530
Subject: [PATCH] Add usage guidelines to the readme

---
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/README.md b/README.md
index 05545a2..63b3a7b 100644
--- a/README.md
+++ b/README.md
@@ -16,6 +16,15 @@ A high level view of the system is as follows:
 - Print the results
 
 
+## Usage
+Run the file `main.py` without any command line arguments to view the classifier performance on the available test set. In order to test on the custom input, run the following command:
+
+```
+python main.py "Custom input string goes here"
+```
+
+In the command, custom input string can also be specified without quotes.
+
 ## Example Workflow
 ```
 name: SMS Spam Detection Action
@@ -48,3 +57,7 @@ jobs:
       run: |
         python main.py
 ```
+
+
+## Contributing
+Please feel free to create an issue if you find a bug or send a pull request if you wish to improve the existing code/add a new feature.