diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..075534e
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,24 @@
+a personal neocities page using 11ty as a static site generator. deploys to https://uuupah.neocities.com.
+
+# getting started
+
+1. clone the repo
+
+`git clone https://github.com/uuupah/11ty_neocities.git && cd 11ty_neocities`
+
+2. install dependencies
+
+`npm install`
+
+3. start the dev instance 
+
+`npm start`
+
+# links
+
+hosted on neocities - https://uuupah.neocities.com
+
+automatically builds and deploys on a commit to main using [bcomnes' deploy-to-neocities github action](https://github.com/bcomnes/deploy-to-neocities)
+
+i got started using [flamed fury's 11ty guide](https://flamedfury.com/guides/11ty-homepage-neocities/)
+