MrSphay/envHelper
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Add README section dividers
All checks were successful
Build Windows App / build-windows (push) Successful in 17m24s
Details

Browse Source
This commit is contained in:
MrSphay
2026-05-02 00:33:14 +02:00
parent a5b9fc0cf7
commit 0abe51b982
3 changed files with 37 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@@ -12,7 +12,7 @@
<img alt="Version" src="https://img.shields.io/badge/version-0.1.0-111827">
</p>
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Table of Contents
@@ -29,7 +29,7 @@
- [Security](#security)
- [Project Info](#project-info)
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Overview
@@ -37,7 +37,7 @@ EnvHelper reads `.env` files or plain text, detects `CHANGE_ME` placeholders, in
The app is local-first. It does not send generated secrets or input files to external services.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Features
@@ -52,7 +52,7 @@ The app is local-first. It does not send generated secrets or input files to ext
| Languages | German, English, Spanish, French, and Dutch |
| Build output | Windows setup and portable executables via Gitea Runner |
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Workflow
@@ -71,7 +71,7 @@ POSTGRES_PASSWORD=... -> Infer formats -> POSTGRES_PASSWORD=...
SESSION_SECRET=... Generate local values SESSION_SECRET=...
```
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Example
@@ -109,7 +109,7 @@ BOOTSTRAP_ADMIN_PASSWORD=Wz4...strongPassword
The actual values are generated randomly on the local machine.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Placeholder Detection
@@ -131,7 +131,7 @@ Supported examples:
Additional heuristics cover common `.env.example` variables for SMTP, S3/MinIO, Redis, RabbitMQ, CORS, log levels, environment flags, and API keys.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Default Values
@@ -148,7 +148,7 @@ Default values are shown in their own section. EnvHelper detects likely defaults
Manual defaults can always be added. They override automatically detected defaults and only affect the output, never the input template.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Downloads and Artifacts
@@ -161,7 +161,7 @@ EnvHelper-0.1.0-portable-x64.exe
The files are published by the Gitea Runner as an Actions artifact and as a Generic Package.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Development
@@ -189,7 +189,7 @@ Build Windows packages:
npm run dist:win
```
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Windows Build
@@ -208,7 +208,7 @@ The runner:
5. creates setup and portable executables,
6. uploads artifacts and packages to Gitea.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## README Generation
@@ -221,6 +221,8 @@ blueprint.md
blueprint.json
```
Section dividers are configured as the custom `section-line` template in `blueprint.json` and stamped from `blueprint.md`, so generated README updates keep the same rainbow separators.
Regenerate the README with:
```bash
@@ -229,7 +231,7 @@ npm run readme
The generated output is committed as `README.md` so Gitea can render it directly without any additional tooling.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Security
@@ -248,7 +250,7 @@ WINDOWS_CSC_KEY_PASSWORD
`WINDOWS_CSC_LINK` is the certificate, for example a Base64-encoded `.pfx` file or a reachable certificate URL. `WINDOWS_CSC_KEY_PASSWORD` is the certificate password.
---
<p align="center"><img src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png" alt="-----------------------------------------------------" width="100%"></p>
## Project Info