summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHimanshu Sardana <himanshusardana2005@gmail.com>2026-03-16 20:56:57 +0000
committerHimanshu Sardana <himanshusardana2005@gmail.com>2026-03-16 20:56:57 +0000
commit2bc62aaa80335269871949d4092f0d357904fbb4 (patch)
tree68fa64f319da6189ea725e0f685a7456514dc8fd
parentb1dff440b422226c27e25158b225637bbdfbed27 (diff)
docs: add readme
-rw-r--r--README.md24
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c32cda2
--- /dev/null
+++ b/README.md
@@ -0,0 +1,24 @@
+# Kite
+
+**Kite** is a *blazingly fast* static site generator written in Go. It supports
+multiple themes, boasts near-perfect Lighthouse Scores (99 on Desktop, 94 on
+Mobile)
+
+## Usage
+
+Place your markdown content in the `content/` directory, the output will be in the `output/` directory
+```txt
+.
+├── content
+│ └── blog
+│ └── test.md
+└── output
+ └── blog
+ └── test.html
+ ```
+
+ Run the following command:
+ ```bash
+ kite
+ ```
+