Minor changes to readme for clarity and brevity

This commit is contained in:
Filip Tibell 2023-09-25 14:52:26 -05:00
parent 854c3c6f71
commit 5f7bf6d3f2
No known key found for this signature in database

View file

@ -1,9 +1,9 @@
<!-- markdownlint-disable MD033 --> <!-- markdownlint-disable MD033 -->
<!-- markdownlint-disable MD041 --> <!-- markdownlint-disable MD041 -->
<img align="right" width="250" src="assets/logo/tilt_svg.svg" /> <img align="right" width="250" src="assets/logo/tilt_svg.svg" alt="Lune logo" />
--- <h1 align="center">Lune</h1>
<div align="center"> <div align="center">
<div> <div>
@ -22,26 +22,26 @@
</div> </div>
</div> </div>
--- <br/>
A standalone [Luau](https://luau-lang.org) script runtime. A standalone [Luau](https://luau-lang.org) runtime.
Write and run scripts, similar to runtimes for other languages such as [Node](https://nodejs.org) / [Deno](https://deno.land), or [Luvit](https://luvit.io) for vanilla Lua. Write and run programs, similar to runtimes for other languages such as [Node](https://nodejs.org), [Deno](https://deno.land), [Bun](https://bun.sh), or [Luvit](https://luvit.io) for vanilla Lua.
Lune provides fully asynchronous APIs wherever possible, and is built in Rust 🦀 for optimal safety and correctness. Lune provides fully asynchronous APIs wherever possible, and is built in Rust 🦀 for speed, safety and correctness.
## Features ## Features
- 🌙 A strictly minimal but powerful interface that is easy to read and remember, just like Luau itself - 🌙 Strictly minimal but powerful interface that is easy to read and remember, just like Luau itself
- 🧰 Fully featured APIs for the filesystem, networking, stdio, all included in the small (~4mb) executable - 🧰 Fully featured APIs for the filesystem, networking, stdio, all included in the small (~5mb) executable
- 📚 World-class documentation, on the web _or_ directly in your editor, no network connection necessary - 📚 World-class documentation, on the web _or_ directly in your editor, no network connection necessary
- 🏡 A familiar scripting environment for Roblox developers, with an included 1-to-1 task scheduler port - 🏡 Familiar runtime environment for Roblox developers, with an included 1-to-1 task scheduler port
- ✏️ Optional built-in library for manipulating Roblox place & model files, and their instances - ✏️ Optional built-in library for manipulating Roblox place & model files, and their instances
## Non-goals ## Non-goals
- Making scripts short and terse - proper autocomplete / intellisense make scripting using Lune just as quick, and readability is important - Making programs short and terse - proper autocomplete / intellisense make using Lune just as quick, and readability is important
- Running full Roblox game scripts outside of Roblox - there is some compatibility, but Lune is meant for different purposes - Running full Roblox games outside of Roblox - there is some compatibility, but Lune is meant for different purposes
## Where do I start? ## Where do I start?