update docs

Author: Bhupesh-V

docs/moss.md

@@ -1,40 +1,6 @@
 ## Moss
 > Derived from [Reading the Results](http://moss.stanford.edu/general/format.html).
 
-*PlagCheck* returns the following list of dictionaries:
-```json
-[
-  {
-    "file1":"filename1.py",
-    "file2":"filename2.py",
-    "percentage": 34,
-    "no_of_lines_matched": 3,
-    "lines_matched":[["2-3", "10-11"]]
-  },
-....
-]
-```
-Each dict item contains the following items:
-
-- **file1** & **file2** : 
-The pair of file names that have similar code.
-
-- **percentage** : 
-It is the the percentage of the code in one file considered to match code in the other file.
-
-- **lines_matched** : 
-  Lines Matched is approximately the number of lines of code that matched between 2 given files.
-
-  For example :
-  If ***lines_matched* is [['88-99','119-131']]**
-  
-  Then the line numbers 88-99 of *file1* matched with lines 119-131 of *file2*.
-
-  lines_matched is a list of lists indicating all line number matches between 2 code files.
-
-
-> For both measures(*lines_matched* & *percentage*), higher numbers mean more code matches.
-
 
 
 ## [Tips](http://moss.stanford.edu/general/tips.html)

docs/usage.md

@@ -1,6 +1,6 @@
 # Usage
 
-plagcheck provides the following class constructors
+plagcheck provides the following classes:
 
 ### check(files, lang, user_id)
 
@@ -17,27 +17,28 @@ plagcheck provides the following class constructors
 import os
 import pprint
 from plagcheck import plagcheck
+
 from dotenv import load_dotenv
 load_dotenv()
 
-program_files = [
-  "testfiles/test_python.py",
-  "testfiles/test_python3.py",
-  "testfiles/test_python2.py"
-]
-
 language = "python"
 userid = os.environ["USER_ID"]
 
 
-cheat = plagcheck.check(program_files, language, userid)
+moss = plagcheck.check(language, userid)
+
+moss.addFilesByWildCard("testfiles/test_python*.py")
 
-# cheat.addBaseCode("submission/a01.py")
+# or moss.addFile("testfiles/test_python.py")
 
-cheat.submit()
+moss.submit()
 
-print(cheat.getHomePage())
-pprint.pprint(cheat.getResults())
+print(moss.getHomePage())
+pprint.pprint(moss.getResults())
+# print frequency of each shared solution
+pprint.pprint(moss.getShareScores())
+# print potential distributor-culprit relationships
+pprint.pprint(moss.getInsights())
 
 ```
 
@@ -55,7 +56,7 @@ c.submit()
 ### 2. getHomePage()
 **Parameters** : `None` <br>
 **Return Type** : `String` <br>
-**Description**: Returns the Moss Result HomePage<br>
+**Description**: Returns the Moss Result HomePage URL<br>
 **Demo**:
 ```python
 
@@ -84,4 +85,98 @@ c.getResults()
 ]
 """
 
-```
+```
+
+*getResults()* returns the following list of dictionaries:
+```json
+[
+  {
+    "file1":"filename1.py",
+    "file2":"filename2.py",
+    "percentage": 34,
+    "no_of_lines_matched": 3,
+    "lines_matched":[["2-3", "10-11"]]
+  },
+....
+]
+```
+Each dict item contains the following items:
+
+- **file1** & **file2** : 
+The pair of file names that have similar code.
+
+- **percentage** : 
+It is the the percentage of the code in one file considered to match code in the other file.
+
+- **lines_matched** : 
+  Lines Matched is approximately the number of lines of code that matched between 2 given files.
+
+  For example :
+  If ***lines_matched* is [['88-99','119-131']]**
+  
+  Then the line numbers 88-99 of *file1* matched with lines 119-131 of *file2*.
+
+  lines_matched is a list of lists indicating all line number matches between 2 code files.
+
+
+> For both measures(*lines_matched* & *percentage*), higher numbers mean more code matches.
+
+### 4. addFilesByWildCard()
+**Parameters** : `String` <br>
+**Return Type** : `None` <br>
+**Description**: Add multiple files.<br>
+**Demo**:
+```python
+
+c.addFilesByWildCard("testfiles/test_python*.py")
+# This will add all the files having names like, test_python2, test_python5 etc.
+
+```
+
+### 5. addFile()
+**Parameters** : `String` <br>
+**Return Type** : `None` <br>
+**Description**: Add a single file for submission.<br>
+**Demo**:
+```python
+
+c.addFile("testfiles/test_python.py")
+
+```
+
+### 6. addBaseCode()
+**Parameters** : `String` <br>
+**Return Type** : `None` <br>
+**Description**: Add an allowed code file which is use by Moss to ignore results matching with this file<br>
+**Demo**:
+```python
+
+c.addBaseCode("/base.py")
+
+```
+
+- Moss normally reports all code
+that matches in pairs of files. When a base file is supplied,
+program code that also appears in the base file is not counted in matches.
+- A typical base file will include, for example, the instructor-supplied
+code for an assignment. Multiple Base files are allowed.
+- You should use a base file if it is convenient; base files improve results, but are not usually necessary for obtaining useful information.
+
+### 7. getShareScores()
+**Parameters** : `None` <br>
+**Return Type** : `Dict` <br>
+**Description**: Share Score is a utility which returns frequency of every individual file.<br>
+**Demo**:
+```python
+
+c.getShareScores()
+
+# Will return
+"""
+{'testfiles/test_python.py': 2,
+ 'testfiles/test_python2.py': 2,
+ 'testfiles/test_python3.py': 2}
+"""
+```
+Share Score is basically the frequency of each file appearing in Moss Results.
+i.e Higher the frequency, the more is that solution "shared" by different files.