aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBobby <[email protected]>2025-11-05 20:54:53 +0530
committerGitHub <[email protected]>2025-11-05 20:54:53 +0530
commit046d996268972de633f1c5856d1052c0ad61aa95 (patch)
tree7cef451674895d88f4dd6cd8c53d1ee5e267859d
parent1595e3d80d59847172d48a3204e20d30916b0b47 (diff)
downloadunwordled-046d996268972de633f1c5856d1052c0ad61aa95.tar.xz
unwordled-046d996268972de633f1c5856d1052c0ad61aa95.zip
Initialize README with project details
Added project description, features, technology stack, URL parameters, license, and disclaimer.
-rw-r--r--README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d2713b1
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# 🎯 Unwordled
+
+A beautiful, skeumorphic web application that reveals Wordle answers for any date. Built with vanilla HTML, CSS, and JavaScript.
+
+## Live Site
+
+[https://luciferreeves.github.io/unwordled/](https://luciferreeves.github.io/unwordled/)
+
+## Features
+
+- Daily Wordle answer
+- Historical answers from Wordle launch
+- Future answers
+- Interactive calendar
+- Dark/light theme
+- URL parameter support for sharing specific dates
+- Dynamic Open Graph images for social sharing
+- Fully responsive design
+
+## Technology Stack
+
+- Pure HTML5, CSS3, and JavaScript (ES6+)
+- No frameworks or build tools
+- NYT Wordle API integration
+- Google Fonts (Poppins, Fira Code)
+- Canvas API for dynamic Open Graph image generation
+
+## URL Parameters
+
+Share specific dates using the format:
+```
+?date=DD-MM-YYYY
+```
+
+Example: `?date=25-12-2024`
+
+## License
+
+Licensed under the [MIT License](LICENSE).
+
+## Disclaimer
+
+This is an independent project and is not affiliated with The New York Times or the official Wordle game.