From c81eebcb7828d92000de38a531f80abe45b74679 Mon Sep 17 00:00:00 2001 From: Benno <57860196+bennoinbeta@users.noreply.github.com> Date: Tue, 27 Aug 2024 18:09:53 +0200 Subject: [PATCH] #67 fixed readme --- README.md | 1 + packages/eprel-client/README.md | 6 +++--- packages/eprel-client/package.json | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2c8b330b..26f4a65d 100644 --- a/README.md +++ b/README.md @@ -19,6 +19,7 @@ A collection of open source libraries maintained by [builder.group](https://buil | ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------- | | [cli](https://github.com/builder-group/monorepo/blob/develop/packages/cli) | Straightforward CLI to bundle Typescript libraries with presets, powered by Rollup and Esbuild | [`@blgc/cli`](https://www.npmjs.com/package/@blgc/cli) | | [config](https://github.com/builder-group/monorepo/blob/develop/packages/cli) | Collection of ESLint, Vite, and Typescript configurations | [`@blgc/config`](https://www.npmjs.com/package/@blgc/config) | +| [eprel-client](https://github.com/builder-group/monorepo/blob/develop/packages/eprel-client) | Typesafe and straightforward fetch client for interacting with the European Product Registry for Energy Labelling (EPREL) API using feature-fetch | [`eprel-client`](https://www.npmjs.com/package/eprel-client) | | [feature-fetch](https://github.com/builder-group/monorepo/blob/develop/packages/feature-fetch) | Straightforward, typesafe, and feature-based fetch wrapper supporting OpenAPI types | [`feature-fetch`](https://www.npmjs.com/package/feature-fetch) | | [feature-form](https://github.com/builder-group/monorepo/blob/develop/packages/feature-form) | Straightforward, typesafe, and feature-based form library | [`feature-form`](https://www.npmjs.com/package/feature-form) | | [feature-logger](https://github.com/builder-group/monorepo/blob/develop/packages/feature-logger) | Straightforward, typesafe, and feature-based logging library | [`feature-logger`](https://www.npmjs.com/package/feature-logger) | diff --git a/packages/eprel-client/README.md b/packages/eprel-client/README.md index 1739ac04..fcb137e7 100644 --- a/packages/eprel-client/README.md +++ b/packages/eprel-client/README.md @@ -19,7 +19,7 @@ > Status: Experimental -`eprel-client` is a typesafe and straightforward fetch client for interacting with the European Product Registry for Energy Labelling (EPREL) API using [`feature-fetch`](https://github.com/builder-group/monorepo/tree/develop/packages/feature-fetch). This client provides typesafe methods for fetching and downloading Google Fonts. +`eprel-client` is a typesafe and straightforward fetch client for interacting with the European Product Registry for Energy Labelling (EPREL) API using [`feature-fetch`](https://github.com/builder-group/monorepo/tree/develop/packages/feature-fetch). - [EPREL API Docs](https://webgate.ec.europa.eu/fpfis/wikis/display/EPREL/EPREL+Public+site+-+API) @@ -42,7 +42,7 @@ const client = createEPRELClient({ Fetches the available product groups from the ERAP API. ```ts -const products = await client.getProductGroups(); +const productGroups = await client.getProductGroups(); ``` ### Error Handling @@ -55,7 +55,7 @@ Errors can occur during API requests, and the client will return detailed error ```ts try { - const products = await client.getProductGroups(); + const productGroups = await client.getProductGroups(); } catch (error) { if (error instanceof NetworkError) { console.error('Network error:', error.message); diff --git a/packages/eprel-client/package.json b/packages/eprel-client/package.json index 0fa6b895..ab2805c0 100644 --- a/packages/eprel-client/package.json +++ b/packages/eprel-client/package.json @@ -1,7 +1,7 @@ { "name": "eprel-client", "description": "Typesafe and straightforward fetch client for interacting with the European Product Registry for Energy Labelling (EPREL) API using feature-fetch", - "version": "0.0.1", + "version": "0.0.2", "private": false, "scripts": { "build": "shx rm -rf dist && ../../scripts/cli.sh bundle",