diff --git a/README.md b/README.md index 611ce79..7d482e0 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,25 @@ + -# Lune 🌙 +
+

Lune 🌙

-[![CI](https://github.com/filiptibell/lune/actions/workflows/ci.yaml/badge.svg)](https://github.com/filiptibell/lune/actions/workflows/ci.yaml) -[![Release](https://github.com/filiptibell/lune/actions/workflows/release.yaml/badge.svg)](https://github.com/filiptibell/lune/actions/workflows/release.yaml) +
+ Current Lune library version + CI status + Release status + Current Lune library version +
-A standalone [Luau](https://luau-lang.org) script runner +
---- +A standalone Luau script runner -🚀 Use the ergonomics and readability of Luau instead of shell scripts 🚀 +🚀 Use the ergonomics and readability of Luau for your shell scripts 🚀 -[Full example & walkthrough](.lune/hello_lune.luau) +
+ +
## ⚙️ Installation @@ -27,7 +35,8 @@ You can also download pre-built binaries for most systems directly from the GitH ## ✏️ Writing Lune Scripts -Check out the examples of how to write a script in the [.lune](.lune) folder ! +Check out the examples on how to write a script in the [.lune](.lune) folder !
+A great starting point and walkthrough of Lune can be found in the [Hello, Lune](.lune/hello_lune.luau) example.
🔎 Full list of APIs