From c1a905b5020c4f2f4ade85577e0c36811be87de4 Mon Sep 17 00:00:00 2001
From: Ferenc Szontágh <szf@fsociety.hu>
Date: Mon, 14 Apr 2025 09:08:34 +0000
Subject: [PATCH] packaging, docs

---
 README.md |   55 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 files changed, 53 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 526e1df..d9a4cc3 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,55 @@
-## soniscript
+## voidscript
 
-A simple scripting language in C++
+A lightweight scripting language designed for simplicity and ease of use.
 
+### Features
+
+- Simple and intuitive syntax
+- Built-in standard library
+- Cross-platform compatibility
+- Easy to embed in other applications
+- No external dependencies
+
+### Installation
+
+```bash
+git clone https://github.com/fszontagh/voidscript.git
+cd voidscript
+cmake -S . -B build
+cmake --build build
+```
+
+### Quick Start
+
+```voidscript
+# Hello World example
+print("Hello,", "", "World!", "\n");
+
+# Variables
+int x = 42;
+string name = "VoidScript";
+
+// Functions
+function $add(int $a, double $b, string $help) {
+    int $result = $a + $b;
+    print("The sum is: ", $result, "\n");
+    print("Help: ", $help, "\n");
+    return $result;
+}
+```
+
+### Documentation
+
+For detailed documentation, please visit the [Wiki](https://github.com/fszontagh/voidscript/wiki).
+
+### Contributing
+
+1. Fork the repository
+2. Create your feature branch (`git checkout -b feature/amazing-feature`)
+3. Commit your changes (`git commit -m 'Add some amazing feature'`)
+4. Push to the branch (`git push origin feature/amazing-feature`)
+5. Open a Pull Request
+
+### License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
\ No newline at end of file

--
Gitblit v1.9.3