Merge pull request #15 from ParminCloud/html-readme

mhkarimi1383 · web-flow · commit 6f40cbe70243 · 2024-07-02T13:50:58.000+03:30
✨ feat: html version of readme
diff --git a/README.html b/README.html
@@ -0,0 +1,78 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>ArvanCloud ACME Webhook for CertManger</title>
+  </head>
+  <body>
+    <p align="center">
+      <img
+        src="https://raw.githubusercontent.com/cert-manager/cert-manager/d53c0b9270f8cd90d908460d69502694e1838f5f/logo/logo-small.png"
+        height="256"
+        width="256"
+        alt="cert-manager project logo"
+      />
+    </p>
+
+    <h1>ArvanCloud ACME Webhook for CertManger</h1>
+
+    <a href="https://artifacthub.io/packages/search?repo=arvancloud-webhook">
+      <img
+        src="https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/arvancloud-webhook"
+      />
+    </a>
+    <a href="https://ghcr.io/ParminCloud/arvancloud-certmanager-issuer/">
+      <img
+        src="https://ghcr-badge.egpl.dev/ParminCloud/arvancloud-certmanager-issuer/tags?trim=major&color=green_2&label=Docker%20Tags&ignore=*.sig"
+      />
+    </a>
+    <a href="https://ghcr.io/ParminCloud/arvancloud-certmanager-issuer/">
+      <img
+        src="https://ghcr-badge.egpl.dev/ParminCloud/arvancloud-certmanager-issuer/tags?trim=patch&color=green_2&label=Docker%20Tags&ignore=*.sig"
+        href="https://ghcr.io/ParminCloud/arvancloud-certmanager-issuer/"
+      />
+    </a>
+    <a href="https://github.com/ParminCloud/arvancloud-certmanager-issuer/releases">
+      <img
+        src="https://img.shields.io/github/release/ParminCloud/arvancloud-certmanager-issuer.svg"
+      />
+    </a>
+
+    <p>
+      A more simpler and maintainable ACME Webhook Issuer for CertManager Using
+      ArvanCloud DNS/CDN api
+    </p>
+    <h2>Installation</h2>
+    <h3>Short version</h3>
+    <code>
+      helm install --repo
+      https://ParminCloud.github.io/arvancloud-certmanager-issuer
+      arvancloud-webhook arvancloud-webhook -n cert-manager
+    </code>
+    <h3>Long version</h3>
+    <code>
+      helm repo add arvancloud-webhook
+      https://ParminCloud.github.io/arvancloud-certmanager-issuer
+      <br />
+      helm repo update
+      <br />
+      helm install --namespace=cert-manager arvancloud-webhook
+      arvancloud-webhook
+    </code>
+    <p>
+      After installation you will get notes about usage based on your provided
+      values
+    </p>
+  </body>
+  <style>
+    * {
+      font-family: system-ui;
+    }
+    body {
+      margin: 10%;
+      margin-bottom: 0;
+    }
+    a {
+      color: transparent;
+    }
+  </style>
+</html>
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
   <img src="https://raw.githubusercontent.com/cert-manager/cert-manager/d53c0b9270f8cd90d908460d69502694e1838f5f/logo/logo-small.png" height="256" width="256" alt="cert-manager project logo" />
 </p>
 
-# ArvanCloud ACME Webhook for CertMaanger
+# ArvanCloud ACME Webhook for CertManger
 
 [![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/arvancloud-webhook)](https://artifacthub.io/packages/search?repo=arvancloud-webhook)
 [![Docker Tags](https://ghcr-badge.egpl.dev/ParminCloud/arvancloud-certmanager-issuer/tags?trim=major&color=green_2&label=Docker%20Tags&ignore=*.sig)](https://ghcr.io/ParminCloud/arvancloud-certmanager-issuer/)
@@ -11,9 +11,9 @@
 
 A more simpler and maintainable ACME Webhook Issuer for CertManager Using ArvanCloud DNS/CDN api
 
-## Installation:
+## Installation
 
-### Short version:
+### Short version
 
 ```bash
 helm install --repo https://ParminCloud.github.io/arvancloud-certmanager-issuer arvancloud-webhook arvancloud-webhook -n cert-manager
@@ -23,6 +23,7 @@ helm install --repo https://ParminCloud.github.io/arvancloud-certmanager-issuer
 
 ```bash
 helm repo add arvancloud-webhook https://ParminCloud.github.io/arvancloud-certmanager-issuer
+helm repo update
 helm install --namespace=cert-manager arvancloud-webhook arvancloud-webhook
 ```
 
@@ -33,5 +34,3 @@ After installation you will get notes about usage based on your provided values
 * [x] Add documents and usages (For now checkout helm chart NOTES)
 * [x] Add CI using GH-Actions and complete Helm chart
 * [x] Handle CleanUp
-
-
