Updated readme and email template

Just fixes a few oddities with the readme and also updates the email template to match the style of the existing ones in FOSSBilling.
FOSSBilling · Sep 19, 2023 · e495584 · e495584
1 parent 55eee70
commit e495584
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -16,14 +16,14 @@ All modules can communicate with the other modules using their API endpoints.
 
 ## Optional
 
-* **README.md** - file for installation and getting started instructions
-* **html_admin** folder - for admin area templates, to store custom *.html.twig files
-* **html_client** folder - for client area templates, to store custom *.html.twig files
+* **README.md** - file for installation and getting started instructions.
+* **html_admin** - folder - for admin area templates, to store custom *.html.twig files.
+* **html_client** - folder - for client area templates, to store custom *.html.twig files.
 
 ### Controller folder
 
-* **Admin.php** - if the module has install/uninstall functions or an admin area interface\
-* **Client.php** - if the module has a client area interface
+* **Admin.php** - Defines the module's routes and navigation items for the administrator panel.
+* **Client.php** - Used to define the module's routes for the client / guest area.
 
 ### Api folder
 
@@ -53,4 +53,3 @@ This extension is open source software and is released under the Apache v2.0 lic
 
 This product includes the following third party work:
 * Open Source Iconography by [Pictogrammers](https://pictogrammers.com/) licensed under the [Pictogrammers Free License](https://pictogrammers.com/docs/general/license/).
-* We recommend hosting your extensions on a public [GitHub](https://github.com) repository.
diff --git a/src/html_email/mod_example_email.html.twig b/src/html_email/mod_example_email.html.twig
@@ -1,11 +1,43 @@
 {% block subject %}Example Email Subject{% endblock %}
 {% block content %}
-{% apply markdown %}
-Hi {{ c.first_name }},
-
-This is a test message from fossbilling.org
-
-{{ guest.system_company.signature }}
-
-{% endapply %}
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8">
+    <style type="text/css">
+    body {
+        font-family: Arial, sans-serif;
+        font-size: 14px;
+        color: #333333;
+    }
+    
+    h1 {
+        font-size: 24px;
+        font-weight: bold;
+        margin: 0 0 20px;
+    }
+    
+    p {
+        margin: 0 0 10px;
+    }
+    
+    strong {
+        font-weight: bold;
+    }
+    
+    .signature {
+        font-style: italic;
+        color: #999999;
+        margin-top: 20px;
+        border-top: 1px solid #cccccc;
+        padding-top: 10px;
+    }
+    </style>
+</head>
+<body>
+    <p>Hi {{ c.first_name }},</p>
+    <p>This is a test message from <a href="fossbilling.org">fossbilling.org</a></p>
+    <p class="signature">{{ guest.system_company.signature }}</p>
+</body>
+</html>
 {% endblock %}