Skip to content

Commit

Permalink
Minor changes to readme for clarity and brevity
Browse files Browse the repository at this point in the history
  • Loading branch information
filiptibell committed Sep 25, 2023
1 parent 854c3c6 commit 5f7bf6d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<!-- markdownlint-disable MD033 -->
<!-- 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>
Expand All @@ -22,26 +22,26 @@
</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

- πŸŒ™ A 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
- πŸŒ™ 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 (~5mb) executable
- πŸ“š 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

## Non-goals

- Making scripts short and terse - proper autocomplete / intellisense make scripting 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
- Making programs short and terse - proper autocomplete / intellisense make using Lune just as quick, and readability is important
- Running full Roblox games outside of Roblox - there is some compatibility, but Lune is meant for different purposes

## Where do I start?

Expand Down

0 comments on commit 5f7bf6d

Please sign in to comment.