summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2025-04-10 17:35:46 -0600
committermo khan <mo@mokhan.ca>2025-04-10 17:35:46 -0600
commitd8fd76b1c0c0bd86b2114dcf6af0b6e34d4783f3 (patch)
tree32d71c0e6a9a0c25789ab90a29ef742001898afc /README.md
parenta722bd0ef4f69547229921eb0fe2eefce3ed6397 (diff)
feat: add a single API endpoint to return a list of sparkles
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..48df7d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# sparkled
+
+This is a web application that allows you to say nice things about other people
+called "Sparkles".
+
+A single HTML file can be found in `./public/index.html` that is the home page
+for the web application.
+
+## Getting Started
+
+```bash
+ mise install
+ go run ./cmd/sparkled/main.go
+```