docs(README): improve README.md formatting and add images (#34)

.config/typedoc.css

@@ -34,6 +34,7 @@ pre {
     content: "";
     height: 100%;
     z-index: -1;
+    -webkit-backdrop-filter: blur(6px);
     backdrop-filter: blur(6px);
 }
 
@@ -84,6 +85,7 @@ pre > button {
     padding: 6px 12px;
     border-radius: 4px;
     cursor: pointer;
+    -webkit-backdrop-filter: blur(6px);
     backdrop-filter: blur(6px);
     max-height: calc(100% - 8px * 2);
     display: flex;
@@ -204,9 +206,29 @@ h6:not(.tsd-anchor-link, .tsd-returns-title) > a:hover:before {
 }
 
 #tsd-search.has-focus .results {
+    -webkit-backdrop-filter: blur(6px);
     backdrop-filter: blur(6px);
 }
 
 .container-main {
     margin-top: 16px;
 }
+
+img[src="assets/logo.roundEdges.png"],
+img[src="assets/logo.png"] {
+    box-shadow: 0px 4px 12px 0px rgb(0 0 0 / 16%), 0px 8px 64px 0px rgb(0 0 0 / 24%);
+    border-radius: 14px;
+}
+
+div[align="center"] > img[alt="Star please"][src="assets/star.please.roundEdges.png"] ~ p[align="right"],
+div[align="center"] > img[alt="Star please"][src="assets/star.please.png"] ~ p[align="right"] {
+    max-width: 360px;
+}
+div[align="center"] > img[alt="Star please"][src="assets/star.please.roundEdges.png"] ~ p[align="right"]>*,
+div[align="center"] > img[alt="Star please"][src="assets/star.please.png"] ~ p[align="right"]>* {
+    display: none;
+}
+div[align="center"] > img[alt="Star please"][src="assets/star.please.roundEdges.png"] ~ p[align="right"]>:first-of-type,
+div[align="center"] > img[alt="Star please"][src="assets/star.please.png"] ~ p[align="right"]>:first-of-type {
+    display: block;
+}

README.md

@@ -1,9 +1,12 @@
 <div align="center">
+    <img alt="node-llama-cpp Logo" src="assets/logo.roundEdges.png" width="360px" />
+    <h1>Node Llama.cpp</h1>
+    <p>Node.js bindings for llama.cpp</p>
+    <sub>Pre-built bindings are provided with a fallback to building from source with node-gyp</sub>
+    <p></p>
+</div>
 
-# Node Llama.cpp
-Node.js bindings for llama.cpp.
-
-<sub>Pre-built bindings are provided with a fallback to building from source with `node-gyp`.<sub>
+<div align="center">
 
 [![Build](https://github.com/withcatai/node-llama-cpp/actions/workflows/build.yml/badge.svg)](https://github.com/withcatai/node-llama-cpp/actions/workflows/build.yml)
 [![License](https://badgen.net/badge/color/MIT/green?label=license)](https://www.npmjs.com/package/node-llama-cpp)
@@ -312,3 +315,17 @@ Options:
   -h, --help     Show help                                                                 [boolean]
   -v, --version  Show version number                                                       [boolean]
 ```
+
+## Acknowledgements
+* llama.cpp: [ggerganov/llama.cpp](https://github.com/ggerganov/llama.cpp)
+
+
+<br />
+
+<div align="center" width="360">
+    <img alt="Star please" src="assets/star.please.roundEdges.png" width="360px" margin="auto" />
+    <br/>
+    <p align="right">
+        <i>If you like this repo, star it ✨</i>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
+    </p>
+</div>

package.json

@@ -44,7 +44,7 @@
     "prebuild": "rm -rf ./dist ./tsconfig.tsbuildinfo",
     "build": "tsc --build tsconfig.json --force",
     "addPostinstallScript": "npm pkg set scripts.postinstall=\"node ./dist/cli/cli.js postinstall\"",
-    "generate-docs": "typedoc",
+    "generate-docs": "typedoc && cp -r ./assets/*.png ./docs/assets/",
     "prewatch": "rm -rf ./dist ./tsconfig.tsbuildinfo",
     "watch": "tsc --build tsconfig.json --watch --force",
     "node-gyp-llama": "cd llama && node-gyp",