From e93ffdabb027079e986ac94cf841bce4852324ce Mon Sep 17 00:00:00 2001 From: sammyette Date: Fri, 19 Jul 2024 17:03:24 -0400 Subject: [PATCH] docs: add readme for midnight edition --- README.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9d6446c..9298aa0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -
+
🌓 The Moon-powered shell! A comfy and extensible shell for Lua fans! 🌺 ✨
@@ -9,6 +9,19 @@ Discord
+# Midnight Edition +> [!CAUTION] +> This is a **HEAVILY** WORK IN PROGRESS branch which makes a lot of internal changes. +Functionality **will** be missing if you use this branch, and you may see crashes too. +Tread lightly. + +Hilbish: Midinight Edition is a version of Hilbish meant to be compatible with +the original C implementation of Lua by using a Go library binding. The end goal +is to offer Midnight Edition as a separate, "not as supported" build for users +that *really* want to access a certain library made for C Lua. The standard edition, +which is all native Go, will always be more supported than Midnight Edition. + +# Back to the original README Hilbish is an extensible shell designed to be highly customizable. It is configured in Lua and provides a good range of features. It aims to be easy to use for anyone but powerful enough for