Merge pull request #54 from rohaquinlop/issue-52

feat(docs): #52 update documentation

README.md

@@ -105,9 +105,8 @@ error, otherwise it will be 0.
 
 ## Use the library from python code
 The available library commands are:
- - `complexipy.main.main`: works the same way as the top-level CLI command `complexipy`
- - `complexipy.main.file_complexity`: takes in a file-path and returns the complexity of the file
- - `complexipy.main.code_complexity`: takes in a string and (provided the string is a parsable snippet of python code) returns the complexity of the snippet.
+ - `complexipy.file_complexity`: takes in a file-path and returns the complexity of the file
+ - `complexipy.code_complexity`: takes in a string and (provided the string is a parsable snippet of python code) returns the complexity of the snippet.
 
 ## Example
 
@@ -154,15 +153,15 @@ The output of the command
 
 Calling `file_complexity` on a file-path:
 ```python
->>> from complexipy.main import file_complexity
+>>> from complexipy import file_complexity
 >>> fc = file_complexity("path/to/file.py")
 >>> fc.complexity
 1
 ```
 
 Calling `file_complexity` on a snippet of code:
 ```python
->>> from complexipy.main import code_complexity
+>>> from complexipy import code_complexity
 >>> snippet = """for x in range(0, 10):
     print(x)
 """

docs/index.md

@@ -102,6 +102,11 @@ If the cognitive complexity of a file or a function is greater than the maximum
 cognitive cognitive complexity, then the return code will be 1 and exit with
 error, otherwise it will be 0.
 
+## Use the library from python code
+The available library commands are:
+ - `complexipy.file_complexity`: takes in a file-path and returns the complexity of the file
+ - `complexipy.code_complexity`: takes in a string and (provided the string is a parsable snippet of python code) returns the complexity of the snippet.
+
 ## Example
 
 ### Analyzing a file
@@ -140,6 +145,27 @@ The cognitive complexity of the file is 1, and the output of the command
 ────────────────────────── 🎉 Analysis completed! 🎉 ───────────────────────────
 ```
 
+#### Using the library
+
+Calling `file_complexity` on a file-path:
+```python
+>>> from complexipy import file_complexity
+>>> fc = file_complexity("path/to/file.py")
+>>> fc.complexity
+1
+```
+
+Calling `file_complexity` on a snippet of code:
+```python
+>>> from complexipy import code_complexity
+>>> snippet = """for x in range(0, 10):
+    print(x)
+"""
+>>> cc = code_complexity(snippet)
+cc.complexity
+1
+```
+
 #### Explaining the results of the analysis
 
 ```python