From d3d4d25788c696f4ffdc93d247018cc2205b7e74 Mon Sep 17 00:00:00 2001
From: infidel <yma@ieee.org>
Date: Sun, 10 Apr 2022 18:00:10 +0700
Subject: [PATCH] Updated readme and open repo to public

---
 README.md | 37 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 36 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9091a4f..aee4d07 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,38 @@
 # Infidel Cupper
 
-This is infidel's fork version of hugo [Cupper](https://github.com/zwbetz-gh/cupper-hugo-theme) theme
+This is infidel's fork version of hugo [Cupper](https://github.com/zwbetz-gh/cupper-hugo-theme) theme. I use this theme for my own site  [nnag.me](https://nnag.me).
+
+## Added Feature
+
+### Plausible integration
+
+#### Shortcode
+
+```go
+    {{ if and (.Site.Params.plsDomain) (.Site.Params.plsUrl) }}
+        <script defer data-domain="{{.Site.Params.plsDomain}}" src="{{.Site.Params.plsUrl | relURL}}"></script>
+    {{ end }}
+
+```
+
+#### params
+
+```yml
+    ...
+    params:
+        plsDomain : <Your Domain>
+        plsUrl    : <Your Plausible script url>
+    ...
+```
+
+### PDF.js
+
+#### shortcode
+
+- `layout/shortcodes/embed-pdf.html`
+
+#### scripts
+
+- `static/js/pdf.js`
+- `static/js/pdf.worker.js`
+