Update README.md

Author: MarcoR1791

README.md

@@ -1,27 +1,27 @@
 # PySPARQL Anything
 ###### The SPARQL Anything Python Library
 
-## User Guide
+## USER GUIDE
 
 ###### INSTALLATION 
 
 To install PySPARQL Anything on your machine type the following in your command prompt:
-```
-pip install pysparql-anything 
+```powershell
+$ pip install pysparql-anything 
 ```
 
 To remove PySPARQL Anything from your machine, do the following.
 
 In your command prompt execute
-```
+```python
 $ python
->>> import pysparql_anything as cli
->>> cli.config.remove_jar()
+>>> import pysparql_anything as sa
+>>> sa.utilities.remove_sparql_anything()
 >>> exit()
 $ pip uninstall pysparql-anything
 ```
 
-###### USAGE
+###### BASIC USAGE
 
 1) Open the command prompt with the current working directory set to the main folder of a SPARQL Anything project.
 
@@ -31,44 +31,42 @@ $ python
 ```
 
 3) Import PySPARQL Anything: 
-```
->>> import pysparql_anything as cli
+```python
+>>> import pysparql_anything as sa
 ```
 
 If the SPARQL Anything jar isn't installed in the API's folder it will now be downloaded there automatically.
 
 4) Initialise a ```pysparql_anything.sparql_anything.SparqlAnything``` object:
-``` 
->>> engine = cli.SparqlAnything()
+```python
+>>> engine = sa.SparqlAnything()
 ```
 
 5) Run the query:
-```
+```python
 >>> engine.run(**kwargs)
 ```
 
-###### QUERY PARAMETERS
-
-The keyword arguments to be set are the same as those of the regular Sparql Anything CLI, minus ```i```.
+###### KEYWORD ARGUMENTS
 
-As the use of the latter flag has been deprecated, it has not been implemented.
+The keyword arguments to be passed to any of the PySPARQL Anything methods are the same as those of the regular SPARQL Anything CLI [1]
 
 For example:
-```
+```python
 >>> engine.run(q='queries/getFacade.sparql', f='TTL', o='C:/Users/Marco/Desktop/facade.ttl')
 ```
 
-All of the keyword arguments except for ```v``` want to be assigned a string literal. 
+All of the keyword arguments except for ```v``` must be assigned a string literal. 
 
 ```v``` requires to be assigned a Python dictionary, as in the following example.
 
 To execute the following query from the SPARQL Anything MusicXML showcase,
-```
+```powershell
 java -jar sparql-anything-0.8.0-SNAPSHOT.jar -q queries/populateOntology.sparql -v filePath="./musicXMLFiles/AltDeu10/AltDeu10-017.musicxml" -v fileName="AltDeu10-017" -f TTL
 ```
 
 with PySPARQL Anything, do
-```
+```python
 >>> engine.run(
     	q='queries/populateOntology.sparql',
     	f='ttl',
@@ -79,28 +77,74 @@ with PySPARQL Anything, do
     )
 ```
 
-For further information see 
+The currently supported arguments are as follows.
+
+```
+ q: str - The path to the file storing the query to execute or the query itself.
+
+ o: str - OPTIONAL - The path to the output file. [Default: STDOUT]
+
+ l: str - OPTIONAL - The path to one RDF file or a folder including a set of
+          files to be loaded. When present, the data is loaded in memory and
+          the query executed against it.
 
-https://github.com/SPARQL-Anything/sparql.anything#command-line-interface-cli .
+ f: str - OPTIONAL -  Format of the output file. Supported values: JSON, XML,
+          CSV, TEXT, TTL, NT, NQ. [Default:TEXT or TTL]
+
+ v: dict[str, str] - OPTIONAL - Values passed as input parameter to a query template.
+                     When by substituting variable names with the values provided.
+                     The argument can be used in two ways:
+                     (1) Providing a single SPARQL ResultSet file. In this case,
+                     the query is executed for each set of bindings in the input result set.
+                     Only 1 file is allowed.
+                     (2) Named variable bindings: the argument value must follow the syntax:
+                     var_name=var_value. The argument can be passed multiple times and
+                     the query repeated for each set of values.
+```
+
+[1] See https://github.com/SPARQL-Anything/sparql.anything#command-line-interface-cli for more information.
 
 ## API
 
 All of PySPARQL Anything functionalities can be accessed via the following four methods of the class 
-```pysparql_anything.sparql_anything.SparqlAnything```.
+``` pysparql_anything.sparql_anything.SparqlAnything ```.
 
-``` run(**kwargs) -> None ```
+The constructor for this class is
+``` python
+pysparql_anything.SparqlAnything(*jvm_options: str) -> pysparql_anything.sparql_anything.SparqlAnything
+```
+where ```*jvm_options``` are the optional string arguments representing the user's preferred JVM options.
+
+As an example, one may have
+```python
+engine = sa.SparqlAnything('-Xrs', '-Xmx6g')
+```
+NOTE: the ```*jvm_options``` are final. Once they are set they cannot be changed without starting a new process.
+This limitation is unfortunately due to the nature of the interaction between the JVM and the Python environment.
+Please see [#6](https://github.com/SPARQL-Anything/PySPARQL-Anything/issues/6) for more information on this issue.
+
+###### METHODS
+``` python
+SparqlAnything.run(**kwargs) -> None
+```
 
 Reflects the functionalities of the original SPARQL Anything CLI. This can be used to run a query the output of
 which is to be printed on the command line or saved to a file. (See example above)
 
-``` ask(**kwargs) -> bool ```
+```python
+SparqlAnything.ask(**kwargs) -> bool
+```
 
 Executes an ASK query and returns a Python boolean True or False.
 
-``` construct(**kwargs) -> rdflib.graph.Graph ```
+```python
+SparqlAnything.construct(**kwargs) -> rdflib.graph.Graph
+```
 
 Executes a CONSTRUCT query and returns a rdflib graph object.
 
-``` select(**kwargs) -> dict ```
+```python
+SparqlAnything.select(**kwargs) -> dict
+```
 
 Executes a SELECT query and returns the result as a Python dictionary.