fix(readme): Improve .env configuration code block formatting in documentation

This commit is contained in:
Philipp Kunz 2025-04-09 08:40:23 +00:00
parent 84cab94beb
commit c4d6403721
3 changed files with 9 additions and 3 deletions

View File

@ -1,5 +1,11 @@
# Changelog # 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) ## 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. No changes detected in project files or documentation. This commit is a placeholder to record that nothing was updated.

View File

@ -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: Below is an example .env file for local development:
------------------------------------------------------------ ```
MONGODB_URL=mongodb://localhost:27017 MONGODB_URL=mongodb://localhost:27017
MONGODB_NAME=opendataDB MONGODB_NAME=opendataDB
MONGODB_USER=myUser MONGODB_USER=myUser
MONGODB_PASS=myPass 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: 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:

View File

@ -3,6 +3,6 @@
*/ */
export const commitinfo = { export const commitinfo = {
name: '@fin.cx/opendata', 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.' 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.'
} }