aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpml68 <tutorialmester@gmail.com>2024-01-16 17:29:29 +0100
committerpml68 <tutorialmester@gmail.com>2024-01-16 17:29:29 +0100
commitb09dc6be07bcbf8f945a7f5594975c68b2abb908 (patch)
tree36d010f152f2a3377321f47407f89cda13b20715
parentInitial commit (diff)
downloadpml68.dev-b09dc6be07bcbf8f945a7f5594975c68b2abb908.tar.gz
docs: add README
Diffstat (limited to '')
-rw-r--r--README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..00e5b73
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# My personal website, built using [SvelteKit](https://kit.svelte.dev), hosted by [GitHub pages](https://pages.github.com)
+
+[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0) &nbsp;
+[![GitHub Release](https://img.shields.io/github/v/release/Olah-Barbershop/website)](https://github.com/Olah-Barbershop/website/releases/latest) &nbsp;
+[![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/Olah-Barbershop/website/deploy.yml)](https://github.com/Olah-Barbershop/website/actions) &nbsp;
+[![Website](https://img.shields.io/website?url=https%3A%2F%2Fweb.olahbarbershop.codes)](https://web.olahbarbershop.codes)
+
+# Running locally
+
+```sh
+git clone https://github.com/pml68/website
+cd website
+pnpm install
+pnpm dev
+```