readme MD

README.md

@@ -13,7 +13,7 @@ its is currently developed by the **Remote Perception Group** in [**CentroGeo**]
 
 ## APISentinel
 This class makes easier the usage of [sentinel API](https://github.com/sentinelsat/sentinelsat).
-The class constructor requires a username and password form [copernicus project](https://scihub.copernicus.eu/dhus/#/self-registration)
+The class constructor requires a username and password from [copernicus project](https://scihub.copernicus.eu/dhus/#/self-registration), more information about the function is available in the function's docstring.
 ### Dependencies
 ```bash
 sudo pip install sentinelsat

geosentinel/APISentinel.py

@@ -53,16 +53,17 @@ class APISentinel(object):
 
 		Args:
 			self (pointer): The object pointer.
-			area (str): area of interest using a Polygon in WKT format.
+			area (str): Area of interest using a Polygon in WKT format.
+			date (tuple): A tuple contining the initial and end dates. 
+			searchParameters (dict): Additional keywords can be used to specify other query parameters, 
+				Other Parameters: Additional keywords can be used to specify other query parameters,
+				e.g. {"platformname":"Sentinel-2", "cloudcoverpercentage":"[0 TO 40]"} 
+				See https://scihub.copernicus.eu/twiki/do/view/SciHubUserGuide/3FullTextSearch for a full list. Ran-
+				ge values can be passed as two-element tuples, e.g. cloudcoverpercentage=(0, 30).
+				The time interval formats accepted by the `date` parameter can also be used with any other parameters that expect time intervals
+				(that is: 'beginposition', 'endposition', 'date', 'creationdate', and 'ingestiondate').
 		Example:
-			"POLYGON((-89.99 21.27,-89.13 21.29,-89.30 20.68,-90.04 20.71,-89.99 21.27))"
-			date (str): Initial date and end date.
-			searchParameters (str): Type platform Sentinel-1 or Sentinel-2, e.g. area_relation=[‘Intersects’, ‘Contains’, ‘IsWithin’]
-			Other Parameters: Additional keywords can be used to specify other query parameters, e.g. relativeorbitnum-
-			ber=70. See https://scihub.copernicus.eu/twiki/do/view/SciHubUserGuide/3FullTextSearch for a full list. Ran-
-			ge values can be passed as two-element tuples, e.g. cloudcoverpercentage=(0, 30). The time interval formats
-			accepted by the ``date`` parameter can also be used with any other parameters that  expect time intervals
-			(that is:'beginposition', 'endposition',
+			getProducts("POLYGON((-89.99 21.27,-89.13 21.29,-89.30 20.68,-90.04 20.71,-89.99 21.27))", ('20150101', '20181024'), {"platformname":"Sentinel-2", "cloudcoverpercentage":"[0 TO 40]"})
 
 		Returns:
 			OrderedDict: Sentinel Product list found.