readme

unsync · Jan 24, 2024 · f12b36d · f12b36d
1 parent e979dd2
commit f12b36d
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
 # veolia-client
+
+### usage
+
+```ts 
+const client = new VeoliaClient({
+    password: 'string',
+    mail: 'string',
+    pdl: 'string'
+})
+
+// all history
+const allEnergyData = await client.getEnergyData(null)
+
+// all history from a date
+const partialEnergyData = await client.getEnergyData(dayjs('2024-01-01'))
+```