From 0d27ee549129ff0340c2601e3e78e67f08d658d7 Mon Sep 17 00:00:00 2001
From: vanten-s <vanten-s@vanten-s.com>
Date: Wed, 27 Sep 2023 09:21:10 +0200
Subject: [PATCH] Added a README

---
 README.md | 41 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 41 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5447333
--- /dev/null
+++ b/README.md
@@ -0,0 +1,41 @@
+# Plonkus
+
+## About
+This is a small hobby language that I created because I was bored.
+It only supports [my own architecture](https://github.com/vanten-s/8bit-computer) but I'm planning to extend it to x86 some day.
+
+## Features
+Currently the language has the following
+- Expressions
+- Scopes
+- Functions
+- Variables
+But more features like
+- If statements
+- Loops
+- Function calls in expressions
+- Comments
+Are coming.
+
+## Syntax
+Here is example of functions, built-ins and variables and Scopes
+
+```plonkus
+fn main {
+    let a = 2;
+    {
+        let a = a + 1;
+        out(a);
+    }
+    test(a);
+    exit();
+}
+
+fn test output {
+    let number_to_output = output;
+    out(number_to_output);
+}
+```
+
+This code prints 3 and then 2.
+