Document resampling README (#57)

cwasicki · web-flow · commit e5b2f02a0ff9 · 2024-05-15T14:53:15.000Z
Addressing issue #56 - add the optional resolution of 1 sec to the README.
diff --git a/README.md b/README.md
@@ -30,7 +30,7 @@ Please also refer to [examples](https://github.com/frequenz-floss/frequenz-clien
 
 ```bash
 # Choose the version to install
-VERSION=0.2.0
+VERSION=0.3.0
 pip install frequenz-client-reporting==$VERSION
 ```
 
@@ -60,6 +60,7 @@ data = [
         start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),
         end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),
         page_size=10000,
+        resolution=1,
     )
 ]
 ```
@@ -87,6 +88,7 @@ data = [
         start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),
         end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),
         page_size=10000,
+        resolution=1,
     )
 ]
 ```

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ Please also refer to [examples](https://github.com/frequenz-floss/frequenz-clien`
`30`	`30`
`31`	`31`	```bash
`32`	`32`	`# Choose the version to install`
`33`		`-VERSION=0.2.0`
	`33`	`+VERSION=0.3.0`
`34`	`34`	`pip install frequenz-client-reporting==$VERSION`
`35`	`35`	```
`36`	`36`
`@@ -60,6 +60,7 @@ data = [`
`60`	`60`	`start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),`
`61`	`61`	`end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),`
`62`	`62`	`page_size=10000,`
	`63`	`+ resolution=1,`
`63`	`64`	`)`
`64`	`65`	`]`
`65`	`66`	```
`@@ -87,6 +88,7 @@ data = [`
`87`	`88`	`start_dt=datetime.fromisoformat("2024-05-01T00:00:00"),`
`88`	`89`	`end_dt=datetime.fromisoformat("2024-05-02T00:00:00"),`
`89`	`90`	`page_size=10000,`
	`91`	`+ resolution=1,`
`90`	`92`	`)`
`91`	`93`	`]`
`92`	`94`	```