From 86530202b3c9473a06440340c0a4e202ccab9335 Mon Sep 17 00:00:00 2001
From: Borodinov Ilya <borodinov.ilya@gmail.com>
Date: Mon, 11 Nov 2024 23:32:35 +0300
Subject: [PATCH] readme improvements

---
 README.md | 12 ++++++++++++
 SYNTAX.md |  3 +++
 2 files changed, 15 insertions(+)
 create mode 100644 README.md
 create mode 100644 SYNTAX.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d48a416
--- /dev/null
+++ b/README.md
@@ -0,0 +1,12 @@
+# Cogs - Rust in HTML
+
+Cogs is a fullstack framework for building HATEOAS-based web applications using a custom templating language that compiles directly to highly-optimized Rust code.
+
+[HTMX](https://htmx.org/) is recommended alongside Cogs as the frontend piece of the HATEOAS stack.
+
+## Roadmap
+
+- [ ] Basic syntax and parsing
+- [ ] Code generation
+- [ ] (?) Custom codegen based HTMX alternative
+- [ ] (?) WASM-based "Client Components"
diff --git a/SYNTAX.md b/SYNTAX.md
new file mode 100644
index 0000000..7ac045a
--- /dev/null
+++ b/SYNTAX.md
@@ -0,0 +1,3 @@
+# Syntax
+
+TODO