From 9cf13e69904699ce0ba144b02b432a5d3bfe834e Mon Sep 17 00:00:00 2001
From: qlrd <106913782+qlrd@users.noreply.github.com>
Date: Sat, 16 Sep 2023 14:32:05 -0300
Subject: [PATCH] Modified Readme

Added a 'markdownlint' package to lint locally the README.md

fixed README.md according its rules
---
 README.md    | 17 +++++++++--------
 package.json |  4 +++-
 2 files changed, 12 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index 4a846340..69afc0a7 100644
--- a/README.md
+++ b/README.md
@@ -26,7 +26,9 @@ For more information, see [flash the firmware onto the device](https://selfcusto
 
 ## Install
 
-- See [releases page](https://github.com/selfcustody/krux-installer/releases); or 
+- See [releases page](https://github.com/selfcustody/krux-installer/releases);
+or
+
 - [Build from source](/#build-from-source)
 
 ## Build from source
@@ -125,10 +127,11 @@ to setup the build `target` on specific `os` (Operational System).
 The `<target>` depends depends on the running platform
 (i.e., `linux`, `darwin` -- MacOS, and `win32` -- Windows).
 
-For more information, see
-[Electron Builder configuration](https://www.electron.build/configuration/configuration)
+For more information,
+see [Electron Builder](https://www.electron.build/configuration/configuration)
+page.
 
-#### Run all tests:
+#### Run all tests
 
 The `wdio.conf.mts` is configured to check
 if your system have `krux.zip.*` resources.
@@ -136,7 +139,6 @@ if your system have `krux.zip.*` resources.
 - If not, it will, run all tests, including download tests;
 - If yes, it will skip tests that download resources.
 
-
 ```bash
 yarn run build
 ```
@@ -153,7 +155,6 @@ If you want to debug some messages, add the
 
 In linux/mac:
 
-
 ```bash
 DEBUG=krux:* yarn run build --<os> <target>
 ```
@@ -172,7 +173,6 @@ yarn run e2e --filter '0([0-1][0-9]|2[0-4]).*.spec.ts'
 
 if you want to debug some messages:
 
-
 ```bash
 DEBUG=krux:* yarn run e2e --filter '0([0-1][0-9]|2[0-4]).*.spec.ts'
 ```
@@ -198,6 +198,7 @@ The compilation process is done entirely in a reproducible virtual environment a
 therefore, not locally, with the github-action [compile-openssl-windows-action](https://github.com/qlrd/compile-openssl-windows-action/actions).
 
 Since it is compiled in a virtual environment on github:
+
 - it is expected to be fully verifiable and free of malicious code;
 - it is expected that, if you're developing in Windows machine,
 some difficulties will be appear.
@@ -235,4 +236,4 @@ some difficulties will be appear.
 - MacOS:
   - [x] Build DMG installer;
   - [ ] Build PKG installer;
-  - [ ] Build MAS installer;
\ No newline at end of file
+  - [ ] Build MAS installer;
diff --git a/package.json b/package.json
index 63b3dd75..6586052c 100644
--- a/package.json
+++ b/package.json
@@ -34,7 +34,8 @@
     "dev": "vue-tsc --noEmit && vite",
     "build": "vue-tsc --noEmit && vite build && electron-builder",
     "preview": "vite preview",
-    "e2e": "wdio run wdio.conf.mts"
+    "e2e": "wdio run wdio.conf.mts",
+    "lint:md": "markdownlint README.md --ignore node_modules"
   },
   "devDependencies": {
     "@babel/cli": "^7.22.9",
@@ -56,6 +57,7 @@
     "electron": "^26.0.0",
     "electron-builder": "^24.4.0",
     "glob": "^10.3.3",
+    "markdownlint-cli": "^0.36.0",
     "mocha": "^10.2.0",
     "os-lang": "^3.1.1",
     "rimraf": "^5.0.1",