Merge branch 'doc/improvements' into 'main'

Doc/improvements

See merge request !21

README.md

@@ -48,7 +48,7 @@ Tag your figure/plot with an ID. It is possible to tag multiple figures at once.
 The variable "figures" can be a single figure or a list of multiple figures.  
 The argument "plot_engine" defines which plot engine was used to create the figures. It also determines which plot engine plotID uses to place the ID on the plot. Currently supported plot engines are:
 - 'matplotlib', which processes figures created by matplotlib.
-- 'image', which processes pictures with common extensions (jpg, png, etc.)
+- 'image', which processes pictures with common extensions (jpg, png, etc.).
 
 tagplot returns a list that contains two lists each with as many entries as figures were given. The first list contains the tagged figures. The second list contains the corresponding IDs as strings
 
@@ -84,7 +84,7 @@ Optional parameters can be used to customize the publish process.
   - centralized: The raw data will copied only once. All other plots will reference this data via sym link.
   - individual: The complete raw data will be copied to a folder for every plot, respectively.
 Example:
-`publish('/home/user/Documents/research_data', '/home/user/Documents/exported_data', FIG1, 'EnergyOverTime-Plot')
+`publish('/home/user/Documents/research_data', '/home/user/Documents/exported_data', FIG1, 'EnergyOverTime-Plot')`  
 
 ## Build
 If you want to build plotID yourself, follow these steps:  
@@ -100,4 +100,4 @@ If you want to build plotID yourself, follow these steps:
 
 ## Documentation
 If you have more questions about plotID, please have a look at the [documentation](https://plotid.pages.rwth-aachen.de/plotid_python).  
-Also have a look at the example.py that is shipped with plotID.
+Also have a look at the [example.py](plotid/example.py) that is shipped with plotID.