@tvanlaerhoven/epex-client - npm Package Compare versions

Comparing version 1.0.1 to 1.0.2

CHANGELOG.md

 # @tvanlaerhoven/epex-client
 
+## 1.0.2
+
+### Patch Changes
+
+- 1b8de05: Fixed an issue where the bundle and type files were incorrectly mentioned in package.json.
+
 ## 1.0.1
@@ -4,0 +10,0 @@

package.json

 {
   "name": "@tvanlaerhoven/epex-client",
-  "version": "1.0.1",
-  "description": "Get European Power Exchange (EPEX) market data",
+  "version": "1.0.2",
+  "description": "Collect European Power Exchange (EPEX) market data",
   "main": "dist/bundle.cjs.js",
   "module": "dist/bundle.esm.js",
-  "types": "dist/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "files": [
@@ -16,3 +16,3 @@ "dist",
     "watch": "rollup -c --watch",
-    "example": "node example/proxy_server.js & lite-server",
+    "example": "npm run build && node example/proxy_server.js & lite-server",
     "prettier": "prettier --check \"(src|example)/**/*.{js,ts}\"",
@@ -22,2 +22,3 @@ "prettier:fix": "prettier --write \"(src|example)/**/*.{js,ts}\"",
     "lint:fix": "npm run lint -- --fix",
+    "changeset:entry": "npx changeset",
     "prepare": "husky"
@@ -40,3 +41,8 @@ },
   },
-  "keywords": [],
+  "keywords": [
+    "epex",
+    "epex-spot",
+    "smartenergy",
+    "energy"
+  ],
   "devDependencies": {
@@ -47,15 +53,16 @@ "@changesets/cli": "^2.27.11",
     "@types/node": "^22.10.2",
-    "@typescript-eslint/eslint-plugin": "^8.18.2",
-    "@typescript-eslint/parser": "^8.18.2",
     "cors-anywhere": "^0.4.4",
     "eslint": "^9.17.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-prettier": "^5.2.1",
     "husky": "^9.1.7",
     "lint-staged": "^15.2.11",
     "lite-server": "^2.6.1",
-    "prettier": "^3.4.2",
+    "prettier": "3.4.2",
     "rimraf": "^6.0.1",
     "rollup": "^4.29.1",
     "rollup-plugin-typescript2": "^0.36.0",
-    "typescript": "^5.7.2"
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.18.2"
   }
 }

README.md

 # Epex Client
 
-The *Epex Client* package enables querying of the latest European Power Exchange (EPEX) market data. 
-It is intended primarily for hobbyist solutions, as the data is sourced directly from the official 
-[EPEX website](https://www.epex.com).
+The *Epex Client* package provides access to the latest European Power Exchange (EPEX) market data **across all areas**.
+It is intended primarily for hobbyist solutions.
 
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+[![npm version](https://img.shields.io/npm/v/@tvanlaerhoven/epex-client)](https://www.npmjs.com/package/@tvanlaerhoven/epex-client)
+![CI](https://github.com/tvanlaerhoven/epex-client/actions/workflows/ci.yml/badge.svg)
+
+<table>
+  <tr>
+    <td style="vertical-align: top;">
+      <img src="./docs/table.png" alt="Market Prices" width="350"/>
+    </td>
+    <td style="vertical-align: top;">
+      <img src="./docs/bars.png" alt="Market Prices" width="450"/>
+    </td>
+  </tr>
+</table>
+
 ## Overview
@@ -14,2 +28,11 @@
 
+The *Epex Client* package gives you access to the EPEX Spot Day-Ahead Market, where the electricity price and volume
+for each hour of the next day is established.
+You can work with these Day-Ahead prices by adjusting your electricity consumption patterns based on the price 
+fluctuations. Here's how:
+
+- **Shift High Consumption Activities**: reduce energy costs by scheduling energy-intensive activities (like running washing machines, dishwashers, or electric heating) during hours when electricity prices are lower.
+- **Use Home Automation**: home automation systems or smart appliances can automatically adjust the timing of electricity usage based on the predicted lower-cost periods provided by the Epex-client.
+- **Energy Storage**: energy storage systems (like batteries) can store electricity during low-price hours and use it during peak-price hours.
+
 ## Installation
@@ -38,4 +61,7 @@
 
-Then request the market data:
+### Accessing day-ahead market data
 
+The day-ahead market data contains the established electricity prices and quantities for a selected region, 
+based on supply and demand. As an example. the data for `MarketArea.Belgium` can be requested as follows:
+
 ```typescript
@@ -51,4 +77,8 @@ try {
 
-## Rendering market data in a browser
+The requested delivery date is passed as a string `"YYY-MM-DD"`, or using the convenient methods `Epex.today()` and
+`Epex.tomorrow()`. 
+Note that prices for the next day are typically available **in the early afternoon** on the day before delivery.
 
+### Displaying market data in a browser
+
 The Epex website does not allow browser requests from any other location than its own host 
@@ -70,7 +100,6 @@ ([CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing)). To solve this, run a local
 
-The output is a table with today's market prices:
+The output is a page where you can choose to either visualize today's market prices in table or as a bar graph.
 
-<img src="./docs/table.png" alt="Market Prices" width="500"/>
 
 
 

No alert changes

Improved metrics

Total package byte prevSize

32391

increased by7.12%

Number of lines in readme file

102

increased by39.73%

Worsened metrics

Dev dependency count

17

increased by6.25%

No dependency changes