From 5ab22d043de37022bced41a5262cbf16a0963f28 Mon Sep 17 00:00:00 2001
From: Johannes Kirschbauer <hsjobeki@gmail.com>
Date: Tue, 2 Jul 2024 11:45:48 +0200
Subject: [PATCH] api: clan Modules add readme content

---
 clanModules/borgbackup/README.md      | 11 ++++++++++-
 pkgs/clan-cli/clan_cli/api/modules.py |  8 ++------
 pkgs/clan-cli/tests/test_modules.py   |  1 +
 3 files changed, 13 insertions(+), 7 deletions(-)

diff --git a/clanModules/borgbackup/README.md b/clanModules/borgbackup/README.md
index f05f2a61..638de8b7 100644
--- a/clanModules/borgbackup/README.md
+++ b/clanModules/borgbackup/README.md
@@ -1,4 +1,13 @@
 ---
 description = "Efficient, deduplicating backup program with optional compression and secure encryption."
 categories = ["backup"]
----
\ No newline at end of file
+---
+BorgBackup (short: Borg) gives you:
+
+- Space efficient storage of backups.
+- Secure, authenticated encryption.
+- Compression: lz4, zstd, zlib, lzma or none.
+- Mountable backups with FUSE.
+- Easy installation on multiple platforms: Linux, macOS, BSD, ...
+- Free software (BSD license).
+- Backed by a large and active open source community.
\ No newline at end of file
diff --git a/pkgs/clan-cli/clan_cli/api/modules.py b/pkgs/clan-cli/clan_cli/api/modules.py
index c8dec842..3020b8c0 100644
--- a/pkgs/clan-cli/clan_cli/api/modules.py
+++ b/pkgs/clan-cli/clan_cli/api/modules.py
@@ -1,4 +1,3 @@
-import argparse
 import json
 import re
 import tomllib
@@ -81,6 +80,7 @@ class ModuleInfo:
     description: str
     categories: list[str] | None
     roles: list[str] | None
+    readme: str | None = None
 
 
 def get_modules(base_path: str) -> dict[str, str]:
@@ -142,9 +142,5 @@ def show_module_info(base_path: str, module_name: str) -> ModuleInfo:
         description=frontmatter.description,
         categories=frontmatter.categories,
         roles=get_roles(module_path),
+        readme=readme_content,
     )
-
-
-def command(args: argparse.Namespace) -> None:
-    res = show_module_info(args.flake, args.module_name)
-    print(res)
diff --git a/pkgs/clan-cli/tests/test_modules.py b/pkgs/clan-cli/tests/test_modules.py
index cc45572b..eb92de47 100644
--- a/pkgs/clan-cli/tests/test_modules.py
+++ b/pkgs/clan-cli/tests/test_modules.py
@@ -24,3 +24,4 @@ def test_modules_details(test_flake_with_core: FlakeForTest) -> None:
     assert module_info.categories and "backup" in module_info.categories
     assert module_info.roles
     assert set(module_info.roles) == {"server", "client"}
+    assert module_info.readme is not None and module_info.readme != ""