From c4d6403721da258f7a6482e2443904bf4d123284 Mon Sep 17 00:00:00 2001 From: Philipp Kunz Date: Wed, 9 Apr 2025 08:40:23 +0000 Subject: [PATCH] fix(readme): Improve .env configuration code block formatting in documentation --- changelog.md | 6 ++++++ readme.md | 4 ++-- ts/00_commitinfo_data.ts | 2 +- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/changelog.md b/changelog.md index 0457ed0..7b99d61 100644 --- a/changelog.md +++ b/changelog.md @@ -1,5 +1,11 @@ # Changelog +## 2025-04-09 - 1.5.2 - fix(readme) +Improve .env configuration code block formatting in documentation + +- Wrap the .env variables block in triple backticks for clarity +- Ensure consistency in the Markdown styling of code snippets + ## 2025-04-09 - 1.5.1 - fix(core) No changes detected in project files or documentation. This commit is a placeholder to record that nothing was updated. diff --git a/readme.md b/readme.md index c4b93c0..96e2662 100644 --- a/readme.md +++ b/readme.md @@ -43,12 +43,12 @@ Before diving into any operations, ensure that your development environment is p Below is an example .env file for local development: ------------------------------------------------------------- +``` MONGODB_URL=mongodb://localhost:27017 MONGODB_NAME=opendataDB MONGODB_USER=myUser MONGODB_PASS=myPass ------------------------------------------------------------- +``` Once these variables are set, the library can fetch them using the integrated qenv tool. The following code snippet demonstrates how to import and initialize the library: diff --git a/ts/00_commitinfo_data.ts b/ts/00_commitinfo_data.ts index c54ae3e..0924354 100644 --- a/ts/00_commitinfo_data.ts +++ b/ts/00_commitinfo_data.ts @@ -3,6 +3,6 @@ */ export const commitinfo = { name: '@fin.cx/opendata', - version: '1.5.1', + version: '1.5.2', description: 'A comprehensive TypeScript library that manages open business data for German companies by integrating MongoDB, processing JSONL bulk data, and automating browser interactions for Handelsregister data retrieval.' }